Contains the possible cases for ApplicationEvent.
Defines values for ApplicationPackageCleanupPolicy. Possible values include: 'Invalid', 'Default', 'Automatic', 'Manual'
Contains the possible cases for ApplicationScopedVolumeCreationParameters.
Defines values for ApplicationScopedVolumeKind. Possible values include: 'ServiceFabricVolumeDisk'
Defines values for ApplicationStatus. Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
Defines values for ApplicationTypeDefinitionKind. Possible values include: 'Invalid', 'ServiceFabricApplicationPackage', 'Compose'
Defines values for ApplicationTypeStatus. Possible values include: 'Invalid', 'Provisioning', 'Available', 'Unprovisioning', 'Failed'
Defines values for AutoScalingMechanismKind. Possible values include: 'AddRemoveReplica'
Contains the possible cases for AutoScalingMechanism.
Defines values for AutoScalingMetricKind. Possible values include: 'Resource'
Contains the possible cases for AutoScalingMetric.
Defines values for AutoScalingResourceMetricName. Possible values include: 'cpu', 'memoryInGB'
Defines values for AutoScalingTriggerKind. Possible values include: 'AverageLoad'
Contains the possible cases for AutoScalingTrigger.
Contains the possible cases for BackupConfigurationInfo.
Defines values for BackupEntityKind. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
Contains the possible cases for BackupEntity.
Defines values for BackupPolicyScope. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
Contains the possible cases for BackupScheduleDescription.
Defines values for BackupScheduleFrequencyType. Possible values include: 'Invalid', 'Daily', 'Weekly'
Defines values for BackupScheduleKind. Possible values include: 'Invalid', 'TimeBased', 'FrequencyBased'
Defines values for BackupState. Possible values include: 'Invalid', 'Accepted', 'BackupInProgress', 'Success', 'Failure', 'Timeout'
Contains the possible cases for BackupStorageDescription.
Defines values for BackupStorageKind. Possible values include: 'Invalid', 'FileShare', 'AzureBlobStore'
Defines values for BackupSuspensionScope. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
Defines values for BackupType. Possible values include: 'Invalid', 'Full', 'Incremental'
Contains response data for the cancelRepairTask operation.
Defines values for ChaosEventKind. Possible values include: 'Invalid', 'Started', 'ExecutingFaults', 'Waiting', 'ValidationFailed', 'TestError', 'Stopped'
Contains the possible cases for ChaosEvent.
Defines values for ChaosScheduleStatus. Possible values include: 'Invalid', 'Stopped', 'Active', 'Expired', 'Pending'
Defines values for ChaosStatus. Possible values include: 'Invalid', 'Running', 'Stopped'
Contains the possible cases for ClusterEvent.
Defines values for ComposeDeploymentStatus. Possible values include: 'Invalid', 'Provisioning', 'Creating', 'Ready', 'Unprovisioning', 'Deleting', 'Failed', 'Upgrading'
Defines values for ComposeDeploymentUpgradeState. Possible values include: 'Invalid', 'ProvisioningTarget', 'RollingForwardInProgress', 'RollingForwardPending', 'UnprovisioningCurrent', 'RollingForwardCompleted', 'RollingBackInProgress', 'UnprovisioningTarget', 'RollingBackCompleted', 'Failed'
Defines values for CreateFabricDump. Possible values include: 'False', 'True'
Contains response data for the createRepairTask operation.
Defines values for DataLossMode. Possible values include: 'Invalid', 'PartialDataLoss', 'FullDataLoss'
Defines values for DayOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'
Defines values for DeactivationIntent. Possible values include: 'Pause', 'Restart', 'RemoveData'
Defines values for DeployedApplicationStatus. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'
Contains the possible cases for DeployedServiceReplicaDetailInfo.
Contains the possible cases for DeployedServiceReplicaInfo.
Defines values for DeploymentStatus. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'
Defines values for DiagnosticsSinkKind. Possible values include: 'Invalid', 'AzureInternalMonitoringPipeline'
Contains the possible cases for DiagnosticsSinkProperties.
Defines values for EntityKind. Possible values include: 'Invalid', 'Node', 'Partition', 'Service', 'Application', 'Replica', 'DeployedApplication', 'DeployedServicePackage', 'Cluster'
Defines values for EntryPointStatus. Possible values include: 'Invalid', 'Pending', 'Starting', 'Started', 'Stopping', 'Stopped'
Defines values for FabricErrorCodes. Possible values include: 'FABRIC_E_INVALID_PARTITION_KEY', 'FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR', 'FABRIC_E_INVALID_ADDRESS', 'FABRIC_E_APPLICATION_NOT_UPGRADING', 'FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR', 'FABRIC_E_FABRIC_NOT_UPGRADING', 'FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR', 'FABRIC_E_INVALID_CONFIGURATION', 'FABRIC_E_INVALID_NAME_URI', 'FABRIC_E_PATH_TOO_LONG', 'FABRIC_E_KEY_TOO_LARGE', 'FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED', 'FABRIC_E_INVALID_ATOMIC_GROUP', 'FABRIC_E_VALUE_EMPTY', 'FABRIC_E_NODE_NOT_FOUND', 'FABRIC_E_APPLICATION_TYPE_NOT_FOUND', 'FABRIC_E_APPLICATION_NOT_FOUND', 'FABRIC_E_SERVICE_TYPE_NOT_FOUND', 'FABRIC_E_SERVICE_DOES_NOT_EXIST', 'FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND', 'FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND', 'FABRIC_E_PARTITION_NOT_FOUND', 'FABRIC_E_REPLICA_DOES_NOT_EXIST', 'FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST', 'FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND', 'FABRIC_E_DIRECTORY_NOT_FOUND', 'FABRIC_E_FABRIC_VERSION_NOT_FOUND', 'FABRIC_E_FILE_NOT_FOUND', 'FABRIC_E_NAME_DOES_NOT_EXIST', 'FABRIC_E_PROPERTY_DOES_NOT_EXIST', 'FABRIC_E_ENUMERATION_COMPLETED', 'FABRIC_E_SERVICE_MANIFEST_NOT_FOUND', 'FABRIC_E_KEY_NOT_FOUND', 'FABRIC_E_HEALTH_ENTITY_NOT_FOUND', 'FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION', 'FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS', 'FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS', 'FABRIC_E_SERVICE_ALREADY_EXISTS', 'FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS', 'FABRIC_E_APPLICATION_TYPE_IN_USE', 'FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION', 'FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS', 'FABRIC_E_FABRIC_VERSION_IN_USE', 'FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS', 'FABRIC_E_NAME_ALREADY_EXISTS', 'FABRIC_E_NAME_NOT_EMPTY', 'FABRIC_E_PROPERTY_CHECK_FAILED', 'FABRIC_E_SERVICE_METADATA_MISMATCH', 'FABRIC_E_SERVICE_TYPE_MISMATCH', 'FABRIC_E_HEALTH_STALE_REPORT', 'FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED', 'FABRIC_E_NODE_HAS_NOT_STOPPED_YET', 'FABRIC_E_INSTANCE_ID_MISMATCH', 'FABRIC_E_VALUE_TOO_LARGE', 'FABRIC_E_NO_WRITE_QUORUM', 'FABRIC_E_NOT_PRIMARY', 'FABRIC_E_NOT_READY', 'FABRIC_E_RECONFIGURATION_PENDING', 'FABRIC_E_SERVICE_OFFLINE', 'E_ABORT', 'FABRIC_E_COMMUNICATION_ERROR', 'FABRIC_E_OPERATION_NOT_COMPLETE', 'FABRIC_E_TIMEOUT', 'FABRIC_E_NODE_IS_UP', 'E_FAIL', 'FABRIC_E_BACKUP_IS_ENABLED', 'FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH', 'FABRIC_E_INVALID_FOR_STATELESS_SERVICES', 'FABRIC_E_BACKUP_NOT_ENABLED', 'FABRIC_E_BACKUP_POLICY_NOT_EXISTING', 'FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING', 'FABRIC_E_BACKUP_IN_PROGRESS', 'FABRIC_E_RESTORE_IN_PROGRESS', 'FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING', 'FABRIC_E_INVALID_SERVICE_SCALING_POLICY', 'E_INVALIDARG', 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS', 'FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND', 'FABRIC_E_VOLUME_ALREADY_EXISTS', 'FABRIC_E_VOLUME_NOT_FOUND', 'SerializationError', 'FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR'
Defines values for FabricEventKind. Possible values include: 'ClusterEvent', 'ContainerInstanceEvent', 'NodeEvent', 'ApplicationEvent', 'ServiceEvent', 'PartitionEvent', 'ReplicaEvent', 'PartitionAnalysisEvent', 'ApplicationCreated', 'ApplicationDeleted', 'ApplicationNewHealthReport', 'ApplicationHealthReportExpired', 'ApplicationUpgradeCompleted', 'ApplicationUpgradeDomainCompleted', 'ApplicationUpgradeRollbackCompleted', 'ApplicationUpgradeRollbackStarted', 'ApplicationUpgradeStarted', 'DeployedApplicationNewHealthReport', 'DeployedApplicationHealthReportExpired', 'ApplicationProcessExited', 'ApplicationContainerInstanceExited', 'NodeAborted', 'NodeAddedToCluster', 'NodeClosed', 'NodeDeactivateCompleted', 'NodeDeactivateStarted', 'NodeDown', 'NodeNewHealthReport', 'NodeHealthReportExpired', 'NodeOpenSucceeded', 'NodeOpenFailed', 'NodeRemovedFromCluster', 'NodeUp', 'PartitionNewHealthReport', 'PartitionHealthReportExpired', 'PartitionReconfigured', 'PartitionPrimaryMoveAnalysis', 'ServiceCreated', 'ServiceDeleted', 'ServiceNewHealthReport', 'ServiceHealthReportExpired', 'DeployedServicePackageNewHealthReport', 'DeployedServicePackageHealthReportExpired', 'StatefulReplicaNewHealthReport', 'StatefulReplicaHealthReportExpired', 'StatelessReplicaNewHealthReport', 'StatelessReplicaHealthReportExpired', 'ClusterNewHealthReport', 'ClusterHealthReportExpired', 'ClusterUpgradeCompleted', 'ClusterUpgradeDomainCompleted', 'ClusterUpgradeRollbackCompleted', 'ClusterUpgradeRollbackStarted', 'ClusterUpgradeStarted', 'ChaosStopped', 'ChaosStarted', 'ChaosCodePackageRestartScheduled', 'ChaosReplicaRemovalScheduled', 'ChaosPartitionSecondaryMoveScheduled', 'ChaosPartitionPrimaryMoveScheduled', 'ChaosReplicaRestartScheduled', 'ChaosNodeRestartScheduled'
Contains the possible cases for FabricEvent.
Defines values for FabricReplicaStatus. Possible values include: 'Invalid', 'Down', 'Up'
Defines values for FailureAction. Possible values include: 'Invalid', 'Rollback', 'Manual'
Defines values for FailureReason. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'
Contains response data for the forceApproveRepairTask operation.
Contains response data for the getAadMetadata operation.
Contains response data for the getAllEntitiesBackedUpByPolicy operation.
Contains response data for the getApplicationBackupConfigurationInfo operation.
Contains response data for the getApplicationBackupList operation.
Contains response data for the getApplicationEventList operation.
Contains response data for the getApplicationHealth operation.
Contains response data for the getApplicationHealthUsingPolicy operation.
Contains response data for the getApplicationInfoList operation.
Contains response data for the getApplicationInfo operation.
Contains response data for the getApplicationLoadInfo operation.
Contains response data for the getApplicationManifest operation.
Contains response data for the getApplicationNameInfo operation.
Contains response data for the getApplicationTypeInfoListByName operation.
Contains response data for the getApplicationTypeInfoList operation.
Contains response data for the getApplicationUpgrade operation.
Contains response data for the getApplicationsEventList operation.
Contains response data for the getBackupPolicyByName operation.
Contains response data for the getBackupPolicyList operation.
Contains response data for the getBackupsFromBackupLocation operation.
Contains response data for the getChaosEvents operation.
Contains response data for the getChaos operation.
Contains response data for the getChaosSchedule operation.
Contains response data for the getClusterConfiguration operation.
Contains response data for the getClusterConfigurationUpgradeStatus operation.
Contains response data for the getClusterEventList operation.
Contains response data for the getClusterHealthChunk operation.
Contains response data for the getClusterHealthChunkUsingPolicyAndAdvancedFilters operation.
Contains response data for the getClusterHealth operation.
Contains response data for the getClusterHealthUsingPolicy operation.
Contains response data for the getClusterLoad operation.
Contains response data for the getClusterManifest operation.
Contains response data for the getClusterUpgradeProgress operation.
Contains response data for the getClusterVersion operation.
Contains response data for the getComposeDeploymentStatusList operation.
Contains response data for the getComposeDeploymentStatus operation.
Contains response data for the getComposeDeploymentUpgradeProgress operation.
Contains response data for the getContainerLogsDeployedOnNode operation.
Contains response data for the getContainersEventList operation.
Contains response data for the getCorrelatedEventList operation.
Contains response data for the getDataLossProgress operation.
Contains response data for the getDeployedApplicationHealth operation.
Contains response data for the getDeployedApplicationHealthUsingPolicy operation.
Contains response data for the getDeployedApplicationInfoList operation.
Contains response data for the getDeployedApplicationInfo operation.
Contains response data for the getDeployedCodePackageInfoList operation.
Contains response data for the getDeployedServicePackageHealth operation.
Contains response data for the getDeployedServicePackageHealthUsingPolicy operation.
Contains response data for the getDeployedServicePackageInfoListByName operation.
Contains response data for the getDeployedServicePackageInfoList operation.
Contains response data for the getDeployedServiceReplicaDetailInfoByPartitionId operation.
Contains response data for the getDeployedServiceReplicaDetailInfo operation.
Contains response data for the getDeployedServiceReplicaInfoList operation.
Contains response data for the getDeployedServiceTypeInfoByName operation.
Contains response data for the getDeployedServiceTypeInfoList operation.
Contains response data for the getFaultOperationList operation.
Contains response data for the getImageStoreContent operation.
Contains response data for the getImageStoreFolderSize operation.
Contains response data for the getImageStoreRootContent operation.
Contains response data for the getImageStoreRootFolderSize operation.
Contains response data for the getImageStoreUploadSessionById operation.
Contains response data for the getImageStoreUploadSessionByPath operation.
Contains response data for the getNodeEventList operation.
Contains response data for the getNodeHealth operation.
Contains response data for the getNodeHealthUsingPolicy operation.
Contains response data for the getNodeInfoList operation.
Contains response data for the getNodeInfo operation.
Contains response data for the getNodeLoadInfo operation.
Contains response data for the getNodeTransitionProgress operation.
Contains response data for the getNodesEventList operation.
Contains response data for the getPartitionBackupConfigurationInfo operation.
Contains response data for the getPartitionBackupList operation.
Contains response data for the getPartitionBackupProgress operation.
Contains response data for the getPartitionEventList operation.
Contains response data for the getPartitionHealth operation.
Contains response data for the getPartitionHealthUsingPolicy operation.
Contains response data for the getPartitionInfoList operation.
Contains response data for the getPartitionInfo operation.
Contains response data for the getPartitionLoadInformation operation.
Contains response data for the getPartitionReplicaEventList operation.
Contains response data for the getPartitionReplicasEventList operation.
Contains response data for the getPartitionRestartProgress operation.
Contains response data for the getPartitionRestoreProgress operation.
Contains response data for the getPartitionsEventList operation.
Contains response data for the getPropertyInfoList operation.
Contains response data for the getPropertyInfo operation.
Contains response data for the getProvisionedFabricCodeVersionInfoList operation.
Contains response data for the getProvisionedFabricConfigVersionInfoList operation.
Contains response data for the getQuorumLossProgress operation.
Contains response data for the getRepairTaskList operation.
Contains response data for the getReplicaHealth operation.
Contains response data for the getReplicaHealthUsingPolicy operation.
Contains response data for the getReplicaInfoList operation.
Contains response data for the getReplicaInfo operation.
Contains response data for the getServiceBackupConfigurationInfo operation.
Contains response data for the getServiceBackupList operation.
Contains response data for the getServiceDescription operation.
Contains response data for the getServiceEventList operation.
Contains response data for the getServiceHealth operation.
Contains response data for the getServiceHealthUsingPolicy operation.
Contains response data for the getServiceInfoList operation.
Contains response data for the getServiceInfo operation.
Contains response data for the getServiceManifest operation.
Contains response data for the getServiceNameInfo operation.
Contains response data for the getServiceTypeInfoByName operation.
Contains response data for the getServiceTypeInfoList operation.
Contains response data for the getServicesEventList operation.
Contains response data for the getSubNameInfoList operation.
Contains response data for the getUnplacedReplicaInformation operation.
Contains response data for the getUpgradeOrchestrationServiceState operation.
Defines values for HeaderMatchType. Possible values include: 'exact'
Defines values for HealthEvaluationKind. Possible values include: 'Invalid', 'Event', 'Replicas', 'Partitions', 'DeployedServicePackages', 'DeployedApplications', 'Services', 'Nodes', 'Applications', 'SystemApplication', 'UpgradeDomainDeployedApplications', 'UpgradeDomainNodes', 'Replica', 'Partition', 'DeployedServicePackage', 'DeployedApplication', 'Service', 'Node', 'Application', 'DeltaNodesCheck', 'UpgradeDomainDeltaNodesCheck', 'ApplicationTypeApplications'
Contains the possible cases for HealthEvaluation.
Defines values for HealthState. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Defines values for HostIsolationMode. Possible values include: 'None', 'Process', 'HyperV'
Defines values for HostType. Possible values include: 'Invalid', 'ExeHost', 'ContainerHost'
Defines values for ImpactLevel. Possible values include: 'Invalid', 'None', 'Restart', 'RemoveData', 'RemoveNode'
Contains response data for the invokeContainerApi operation.
Contains response data for the invokeInfrastructureCommand operation.
Contains response data for the invokeInfrastructureQuery operation.
Contains response data for the createOrUpdate operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the getContainerLogs operation.
Contains response data for the createOrUpdate operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the createOrUpdate operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the createOrUpdate operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the addValue operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the show operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the get operation.
Contains response data for the list operation.
Contains response data for the createOrUpdate operation.
Contains response data for the get operation.
Contains response data for the list operation.
Defines values for MoveCost. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Defines values for NetworkKind. Possible values include: 'Local'
Contains the possible cases for NetworkResourcePropertiesBase.
Contains the possible cases for NetworkResourceProperties.
Defines values for NodeDeactivationIntent. Possible values include: 'Invalid', 'Pause', 'Restart', 'RemoveData', 'RemoveNode'
Defines values for NodeDeactivationStatus. Possible values include: 'None', 'SafetyCheckInProgress', 'SafetyCheckComplete', 'Completed'
Defines values for NodeDeactivationTaskType. Possible values include: 'Invalid', 'Infrastructure', 'Repair', 'Client'
Contains the possible cases for NodeEvent.
Defines values for NodeStatus. Possible values include: 'Invalid', 'Up', 'Down', 'Enabling', 'Disabling', 'Disabled', 'Unknown', 'Removed'
Defines values for NodeStatusFilter. Possible values include: 'default', 'all', 'up', 'down', 'enabling', 'disabling', 'disabled', 'unknown', 'removed'
Defines values for NodeTransitionType. Possible values include: 'Invalid', 'Start', 'Stop'
Defines values for NodeUpgradePhase. Possible values include: 'Invalid', 'PreUpgradeSafetyCheck', 'Upgrading', 'PostUpgradeSafetyCheck'
Defines values for OperatingSystemType. Possible values include: 'Linux', 'Windows'
Defines values for OperationState. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'
Defines values for OperationType. Possible values include: 'Invalid', 'PartitionDataLoss', 'PartitionQuorumLoss', 'PartitionRestart', 'NodeTransition'
Defines values for PackageSharingPolicyScope. Possible values include: 'None', 'All', 'Code', 'Config', 'Data'
Defines values for PartitionAccessStatus. Possible values include: 'Invalid', 'Granted', 'ReconfigurationPending', 'NotPrimary', 'NoWriteQuorum'
Contains the possible cases for PartitionAnalysisEvent.
Contains the possible cases for PartitionEvent.
Contains the possible cases for PartitionInformation.
Contains the possible cases for PartitionSafetyCheck.
Defines values for PartitionScheme. Possible values include: 'Invalid', 'Singleton', 'UniformInt64Range', 'Named'
Contains the possible cases for PartitionSchemeDescription.
Defines values for PropertyBatchInfoKind. Possible values include: 'Invalid', 'Successful', 'Failed'
Contains the possible cases for PropertyBatchInfo.
Defines values for PropertyBatchOperationKind. Possible values include: 'Invalid', 'Put', 'Get', 'CheckExists', 'CheckSequence', 'Delete', 'CheckValue'
Contains the possible cases for PropertyBatchOperation.
Defines values for PropertyValueKind. Possible values include: 'Invalid', 'Binary', 'Int64', 'Double', 'String', 'Guid'
Contains the possible cases for PropertyValue.
Contains the possible cases for ProvisionApplicationTypeDescriptionBase.
Defines values for ProvisionApplicationTypeKind. Possible values include: 'Invalid', 'ImageStorePath', 'ExternalStore'
Defines values for QuorumLossMode. Possible values include: 'Invalid', 'QuorumReplicas', 'AllReplicas'
Defines values for ReconfigurationPhase. Possible values include: 'Unknown', 'None', 'Phase0', 'Phase1', 'Phase2', 'Phase3', 'Phase4', 'AbortPhaseZero'
Defines values for ReconfigurationType. Possible values include: 'Unknown', 'SwapPrimary', 'Failover', 'Other'
Contains the possible cases for RepairImpactDescriptionBase.
Defines values for RepairImpactKind. Possible values include: 'Invalid', 'Node'
Contains the possible cases for RepairTargetDescriptionBase.
Defines values for RepairTargetKind. Possible values include: 'Invalid', 'Node'
Defines values for RepairTaskHealthCheckState. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'
Contains the possible cases for ReplicaEvent.
Defines values for ReplicaHealthReportServiceKind. Possible values include: 'Stateless', 'Stateful'
Contains the possible cases for ReplicaHealthState.
Contains the possible cases for ReplicaHealth.
Contains the possible cases for ReplicaInfo.
Defines values for ReplicaKind. Possible values include: 'Invalid', 'KeyValueStore'
Defines values for ReplicaRole. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'
Defines values for ReplicaStatus. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Contains the possible cases for ReplicaStatusBase.
Defines values for ReplicatorOperationName. Possible values include: 'Invalid', 'None', 'Open', 'ChangeRole', 'UpdateEpoch', 'Close', 'Abort', 'OnDataLoss', 'WaitForCatchup', 'Build'
Contains the possible cases for ReplicatorStatus.
Contains response data for the resolveService operation.
Defines values for ResourceStatus. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
Defines values for RestartPartitionMode. Possible values include: 'Invalid', 'AllReplicasOrInstances', 'OnlyActiveSecondaries'
Defines values for RestoreState. Possible values include: 'Invalid', 'Accepted', 'RestoreInProgress', 'Success', 'Failure', 'Timeout'
Defines values for ResultStatus. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending'
Contains the possible cases for RetentionPolicyDescription.
Defines values for RetentionPolicyType. Possible values include: 'Basic', 'Invalid'
Defines values for SafetyCheckKind. Possible values include: 'Invalid', 'EnsureSeedNodeQuorum', 'EnsurePartitionQuorum', 'WaitForPrimaryPlacement', 'WaitForPrimarySwap', 'WaitForReconfiguration', 'WaitForInbuildReplica', 'EnsureAvailability'
Contains the possible cases for SafetyCheck.
Contains the possible cases for ScalingMechanismDescription.
Defines values for ScalingMechanismKind. Possible values include: 'Invalid', 'PartitionInstanceCount', 'AddRemoveIncrementalNamedPartition'
Contains the possible cases for ScalingTriggerDescription.
Defines values for ScalingTriggerKind. Possible values include: 'Invalid', 'AveragePartitionLoad', 'AverageServiceLoad'
Contains the possible cases for SecondaryReplicatorStatus.
Defines values for SecretKind. Possible values include: 'inlinedValue'
Contains the possible cases for SecretResourcePropertiesBase.
Contains the possible cases for SecretResourceProperties.
Defines values for ServiceCorrelationScheme. Possible values include: 'Invalid', 'Affinity', 'AlignedAffinity', 'NonAlignedAffinity'
Contains the possible cases for ServiceDescription.
Defines values for ServiceEndpointRole. Possible values include: 'Invalid', 'Stateless', 'StatefulPrimary', 'StatefulSecondary'
Contains the possible cases for ServiceEvent.
Contains the possible cases for ServiceInfo.
Defines values for ServiceKind. Possible values include: 'Invalid', 'Stateless', 'Stateful'
Defines values for ServiceLoadMetricWeight. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Defines values for ServiceOperationName. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'
Defines values for ServicePackageActivationMode. Possible values include: 'SharedProcess', 'ExclusiveProcess'
Contains the possible cases for ServicePartitionInfo.
Defines values for ServicePartitionKind. Possible values include: 'Invalid', 'Singleton', 'Int64Range', 'Named'
Defines values for ServicePartitionStatus. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'
Contains the possible cases for ServicePlacementPolicyDescription.
Defines values for ServicePlacementPolicyType. Possible values include: 'Invalid', 'InvalidDomain', 'RequireDomain', 'PreferPrimaryDomain', 'RequireDomainDistribution', 'NonPartiallyPlaceService'
Defines values for ServiceStatus. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'
Contains the possible cases for ServiceTypeDescription.
Defines values for ServiceTypeRegistrationStatus. Possible values include: 'Invalid', 'Disabled', 'Enabled', 'Registered'
Contains the possible cases for ServiceUpdateDescription.
Contains response data for the setUpgradeOrchestrationServiceState operation.
Defines values for SizeTypes. Possible values include: 'Small', 'Medium', 'Large'
Defines values for State. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed'
Contains response data for the submitPropertyBatch operation.
Contains response data for the updateRepairExecutionState operation.
Contains response data for the updateRepairTaskHealthPolicy operation.
Defines values for UpgradeDomainState. Possible values include: 'Invalid', 'Pending', 'InProgress', 'Completed'
Defines values for UpgradeKind. Possible values include: 'Invalid', 'Rolling'
Defines values for UpgradeMode. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'
Defines values for UpgradeSortOrder. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'
Defines values for UpgradeState. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'
Defines values for UpgradeType. Possible values include: 'Invalid', 'Rolling', 'Rolling_ForceRestart'
Defines values for VolumeProvider. Possible values include: 'SFAzureFile'
Azure Active Directory metadata used for secured connection to cluster.
The AAD authority url.
The AAD client application Id.
The AAD cluster application Id.
The AAD login url.
The client application redirect address.
The AAD tenant Id.
Azure Active Directory metadata object used for secured connection to cluster.
Azure Active Directory metadata used for secured connection to cluster.
The client authentication method.
Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'
Polymorphic Discriminator
Maximum number of named partitions of the service.
Minimum number of named partitions of the service.
The number of instances to add or remove during a scaling operation.
Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).
Polymorphic Discriminator
Maximum number of containers (scale up won't be performed above this number).
Minimum number of containers (scale down won't be performed below this number).
Each time auto scaling is performed, this number of containers will be added or removed.
Metadata about an Analysis Event.
The analysis delay.
The duration of analysis.
Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.
The name of the application, including the 'fabric:' URI scheme.
Polymorphic Discriminator
Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
The name of the backup policy which is applicable to this Service Fabric application or service or partition.
Describes the backup suspension details.
Identifies the Service Fabric application which is being backed up.
The name of the application, including the 'fabric:' URI scheme.
Polymorphic Discriminator
Describes capacity information for services of this application. This description can be used for describing the following.
List of application capacity metric description.
The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. Default value: 0.
The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.
Container Exited event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The category of event.
Name of Code package.
Name of Container.
Type of EntryPoint.
The identifier for the FabricEvent instance.
Exit code of process.
Shows there is existing related events available.
Host Id.
Name of Container image.
Indicates IsExclusive flag.
Polymorphic Discriminator
Name of Service.
Activation Id of Service package.
Name of Service package.
Start time of process.
The time event was logged.
Indicates if termination is unexpected.
Application Created event.
Application definition kind.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Application type version.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Application Deleted event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Application type version.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Describes a Service Fabric application.
Describes capacity information for services of this application. This description can be used for describing the following.
Managed application identity description.
The name of the application, including the 'fabric:' URI scheme.
List of application parameters with overridden values from their default values specified in the application manifest.
The application type name as defined in the application manifest.
The version of the application type as defined in the application manifest.
Represents the base for all Application Events.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Deployed application health states as found in the health store.
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
The name of the application, including the 'fabric:' URI scheme.
Service health states as found in the health store.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.
Defines the application health policy map used to evaluate the health of an application or one of its children entities.
The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster.
Defines a health policy used to evaluate the health of an application or one of its children entities.
Indicates whether warnings are treated with the same severity as errors. Default value: false.
The health policy used by default to evaluate the health of a service type.
The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. Default value: 0.
The map with service type health policy per service type name. The map is empty by default.
Defines an item in ApplicationHealthPolicyMap.
The key of the application health policy map item. This is the name of the application.
The value of the application health policy map item. This is the ApplicationHealthPolicy for this application.
Application Health Report Expired event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Id of Application instance.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents the health state of an application, which contains the application identifier and the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
Represents the health state chunk of a application. The application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.
The name of the application, including the 'fabric:' URI scheme.
The application type name as defined in the application manifest.
The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description.
The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
The list of application health state chunks that respect the input filters in the chunk query.
Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applications, depending on its properties.
The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists. If the application doesn't exist, no application is returned in the cluster health chunk based on this filter. If the application exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.
The name of the application type that matches the filter. If specified, the filter is applied only to applications of the selected application type, if any exists. If no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter. Each application of the specified application type is included in the cluster health chunk if it respects the other filter properties. If not specified, all applications are matched against the other filter members, like health state filter.
Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter. If the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple deployed application filters. For example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node.
The filter for the health state of the applications. It allows selecting applications if they match the desired health states. The possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).
Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter. If the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters. The application filter may specify multiple service filters. For example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name.
Information about a Service Fabric application.
The mechanism used to define a Service Fabric application. Possible values include: 'Invalid', 'ServiceFabricApplicationDescription', 'Compose'
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The name of the application, including the 'fabric:' URI scheme.
List of application parameters with overridden values from their default values specified in the application manifest.
The status of the application. Possible values include: 'Invalid', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
The application type name as defined in the application manifest.
The version of the application type as defined in the application manifest.
Load Information about a Service Fabric application.
List of application capacity metric description.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The maximum number of nodes where this application can be instantiated. It is the number of nodes this application is allowed to span. For applications that do not have application capacity defined this value will be zero.
The minimum number of nodes for this application. It is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance. For applications that do not have application capacity defined this value will be zero.
The number of nodes on which this application is instantiated. For applications that do not have application capacity defined this value will be zero.
Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.
The maximum node capacity for Service Fabric application. This is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value. If set to zero, capacity for this metric is unlimited on each node. When creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity. When updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.
The name of the metric.
The node reservation capacity for Service Fabric application. This is the amount of load which is reserved on nodes which have instances of this application. If MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application. If set to zero, no capacity is reserved for this metric. When setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric.
The total metric capacity for Service Fabric application. This is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value. When creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.
Information about the application name.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The name of the application, including the 'fabric:' URI scheme.
Application Health Report Created event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Id of Application instance.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Describes an application parameter override to be applied when creating or upgrading an application.
The name of the parameter.
The value of the parameter.
Process Exited event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The category of event.
Name of Code package.
Type of EntryPoint.
The identifier for the FabricEvent instance.
Name of executable.
Exit code of process.
Shows there is existing related events available.
Host Id.
Indicates IsExclusive flag.
Polymorphic Discriminator
Process Id.
Name of Service.
Activation Id of Service package.
Name of Service package.
Start time of process.
The time event was logged.
Indicates if termination is unexpected.
This type describes a application resource.
Internal - used by Visual Studio to setup the debugging session on the local development environment.
User readable description of the application.
Describes the diagnostics definition and usage for an application resource.
Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.
Describes the identity of the application.
Name of the Application resource.
Names of the services in the application. NOTE: This property will not be serialized. It can only be populated by the server.
Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.
Status of the application. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the application. NOTE: This property will not be serialized. It can only be populated by the server.
When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy. NOTE: This property will not be serialized. It can only be populated by the server.
Describes a volume whose lifetime is scoped to the application's lifetime.
Describes parameters for creating application-scoped volumes.
The path within the container at which the volume should be mounted. Only valid path characters are allowed.
Name of the volume being referenced.
The flag indicating whether the volume is read only. Default is 'false'.
Describes parameters for creating application-scoped volumes.
User readable description of the volume.
Polymorphic Discriminator
Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks
User readable description of the volume.
Polymorphic Discriminator
Volume size. Possible values include: 'Small', 'Medium', 'Large'
Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The application type name as defined in the application manifest.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap.
Total number of applications of the application type found in the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health.
Defines an item in ApplicationTypeHealthPolicyMap.
The key of the application type health policy map item. This is the name of the application type.
The value of the application type health policy map item. The max percent unhealthy applications allowed for the application type. Must be between zero and 100.
Path description for the application package in the image store specified during the prior copy operation.
The relative image store path to the application package.
Information about an application type.
The mechanism used to define a Service Fabric application type. Possible values include: 'Invalid', 'ServiceFabricApplicationPackage', 'Compose'
List of application type parameters that can be overridden when creating or updating the application.
The application type name as defined in the application manifest.
The status of the application type. Possible values include: 'Invalid', 'Provisioning', 'Available', 'Unprovisioning', 'Failed'
Additional detailed information about the status of the application type.
The version of the application type as defined in the application manifest.
Contains the manifest describing an application type registered in a Service Fabric cluster.
The XML manifest as a string.
Application Upgrade Completed event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Application type version.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Overall upgrade time in milli-seconds.
The time event was logged.
Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.
Defines a health policy used to evaluate the health of an application or one of its children entities.
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
Describes the parameters for monitoring an upgrade in Monitored mode.
The name of the target application, including the 'fabric:' URI scheme.
List of application parameters with overridden values from their default values specified in the application manifest.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.
The target application type version (found in the application manifest) for the application upgrade.
The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
Application Upgrade Domain Completed event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Target Application type version.
The category of event.
Current Application type version.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Upgrade time of domain in milli-seconds.
Upgrade domains.
State of upgrade.
Describes the parameters for an application upgrade.
Information about the current in-progress upgrade domain.
The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'
The estimated UTC datetime when the upgrade failed and FailureAction was executed.
The name of the target application, including the 'fabric:' URI scheme.
The name of the next upgrade domain to be processed.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
The estimated UTC datetime when the upgrade started.
The target application type version (found in the application manifest) for the application upgrade.
The application type name as defined in the application manifest.
List of health evaluations that resulted in the current aggregated health state.
Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.
The estimated total amount of time spent processing the current upgrade domain.
Information about the upgrade domain progress at the time of upgrade failure.
List of upgrade domains and their statuses.
The estimated total amount of time spent processing the overall upgrade.
The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'
Additional detailed information about the status of the pending upgrade.
Application Upgrade Rollback Completed event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Application type version.
The category of event.
The identifier for the FabricEvent instance.
Describes reason of failure.
Shows there is existing related events available.
Polymorphic Discriminator
Overall upgrade time in milli-seconds.
The time event was logged.
Application Upgrade Rollback Started event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Target Application type version.
The category of event.
Current Application type version.
The identifier for the FabricEvent instance.
Describes reason of failure.
Shows there is existing related events available.
Polymorphic Discriminator
Overall upgrade time in milli-seconds.
The time event was logged.
Application Upgrade Started event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Application type name.
Target Application type version.
The category of event.
Current Application type version.
The identifier for the FabricEvent instance.
Action if failed.
Shows there is existing related events available.
Polymorphic Discriminator
Mode of upgrade.
The time event was logged.
Type of upgrade.
Describes the parameters for updating an ongoing application upgrade.
Defines a health policy used to evaluate the health of an application or one of its children entities.
The name of the application, including the 'fabric:' URI scheme.
Describes the parameters for updating a rolling upgrade of application or cluster.
The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.
Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy.
Total number of applications from the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health.
Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.
Polymorphic Discriminator
Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.
Polymorphic Discriminator
Describes the auto scaling policy
The mechanism that is used to scale when auto scaling operation is invoked.
The name of the auto scaling policy.
Determines when auto scaling operation will be invoked.
Describes the resource that is used for triggering auto scaling.
Polymorphic Discriminator
Name of the resource. Possible values include: 'cpu', 'memoryInGB'
Describes the trigger for performing auto scaling operation.
Polymorphic Discriminator
Describes the average load trigger used for auto scaling.
Polymorphic Discriminator
Lower load threshold (if average load is below this threshold, service will scale down).
Description of the metric that is used for scaling.
Scale interval that indicates how often will this trigger be checked.
Upper load threshold (if average load is above this threshold, service will scale up).
Represents a scaling trigger related to an average load of a metric/resource of a partition.
Polymorphic Discriminator
The lower limit of the load below which a scale in operation should be performed.
The name of the metric for which usage should be tracked.
The period in seconds on which a decision is made whether to scale or not.
The upper limit of the load beyond which a scale out operation should be performed.
Represents a scaling policy related to an average load of a metric/resource of a service.
Polymorphic Discriminator
The lower limit of the load below which a scale in operation should be performed.
The name of the metric for which usage should be tracked.
The period in seconds on which a decision is made whether to scale or not.
The upper limit of the load beyond which a scale out operation should be performed.
Describes the parameters for Azure blob store used for storing and enumerating backups.
The connection string to connect to the Azure blob store.
The name of the container in the blob store to store and enumerate backups from.
Friendly name for this backup storage.
Polymorphic Discriminator
Diagnostics settings for Geneva.
Azure Internal monitoring pipeline account.
Azure Internal monitoring pipeline autokey associated with the certificate.
A description of the sink.
Azure Internal monitoring agent fluentd configuration.
Polymorphic Discriminator
Azure Internal monitoring agent configuration.
Name of the sink. This value is referenced by DiagnosticsReferenceDescription
Azure Internal monitoring pipeline account namespace.
Describes the backup configuration information.
Polymorphic Discriminator
Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
The name of the backup policy which is applicable to this Service Fabric application or service or partition.
Describes the backup suspension details.
Describes the Service Fabric entity that is configured for backup.
Polymorphic Discriminator
Represents a backup point which can be used to trigger a restore.
Name of the Service Fabric application this partition backup belongs to.
Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups.
Unique backup ID .
Location of the backup, relative to the backup store.
Describes the type of backup, whether its full or incremental. Possible values include: 'Invalid', 'Full', 'Incremental'
The date time when this backup was taken.
Epoch of the last record in this backup.
Denotes the failure encountered in getting backup point information.
LSN of the last record in this backup.
Information about the partition to which this backup belongs to
Manifest Version of the service this partition backup belongs to.
Name of the Service Fabric service this partition backup belongs to.
Describes the parameters for triggering partition's backup.
Specifies the details of the backup storage where to save the backup.
Describes a backup policy for configuring periodic backup.
Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event.
Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions
The unique name identifying this backup policy.
Describes the policy to retain backups in storage.
Describes the backup schedule parameters.
Describes the details of backup storage where to store the periodic backups.
Describes the progress of a partition's backup.
Unique ID of the newly created backup.
Location, relative to the backup store, of the newly created backup.
Represents the current state of the partition backup operation. Possible values include: 'Invalid', 'Accepted', 'BackupInProgress', 'Success', 'Failure', 'Timeout'
Specifies the epoch of the last record included in backup.
Denotes the failure encountered in performing backup operation.
The LSN of last record included in backup.
TimeStamp in UTC when operation succeeded or failed.
Describes the backup schedule parameters.
Polymorphic Discriminator
Describes the parameters for the backup storage.
Friendly name for this backup storage.
Polymorphic Discriminator
Describes the backup suspension details.
Indicates whether periodic backup is suspended at this level or not.
Specifies the scope at which the backup suspension was applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
Describes basic retention policy.
It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it.
It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format.
Polymorphic Discriminator
Describes a Service Fabric property value of type Binary.
Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.
Polymorphic Discriminator
Contains a description of Chaos.
If Chaos is running, these are the parameters Chaos is running with.
Current status of the schedule. Possible values include: 'Invalid', 'Stopped', 'Active', 'Expired', 'Pending'
Current status of the Chaos run. Possible values include: 'Invalid', 'Running', 'Stopped'
Chaos Restart Code Package Fault Scheduled event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The category of event.
Code package name.
The identifier for the FabricEvent instance.
Id of fault group.
Id of fault.
Shows there is existing related events available.
Polymorphic Discriminator
The name of a Service Fabric node.
Service manifest name.
Id of Service package activation.
The time event was logged.
Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.
Describes a map that contains a collection of ChaosContextMapItem's.
Represents an event generated during a Chaos run.
Polymorphic Discriminator
The UTC timestamp when this Chaos event was generated.
Wrapper object for Chaos event.
Represents an event generated during a Chaos run.
Contains the list of Chaos events and the continuation token to get the next segment.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of Chaos events that meet the user-supplied criteria.
Chaos Restart Node Fault Scheduled event.
The category of event.
The identifier for the FabricEvent instance.
Id of fault group.
Id of fault.
Shows there is existing related events available.
Polymorphic Discriminator
Id of Node instance.
The name of a Service Fabric node.
The time event was logged.
Defines all the parameters to configure a Chaos run.
List of cluster entities to target for Chaos faults. This filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification.
Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check.
Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about the Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long. This map is set by the starter of the Chaos run to optionally store the context about the specific run.
Enables or disables the move primary and move secondary faults. Default value: true.
The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities. During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event. Default value: 60.
MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration. Chaos executes in iterations and two consecutive iterations are separated by a validation phase. The higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs. The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up. Default value: 1.
Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue). Default value: '4294967295'.
Wait time (in seconds) between consecutive faults within a single iteration. The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through. The recommendation is to start with a value between 1 and 5 and exercise caution while moving up. Default value: 20.
Time-separation (in seconds) between two consecutive iterations of Chaos. The larger the value, the lower the fault injection rate. Default value: 30.
Defines an item in ChaosParametersDictionary of the Chaos Schedule.
The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs.
Defines all the parameters to configure a Chaos run.
Chaos Move Primary Fault Scheduled event.
The category of event.
The identifier for the FabricEvent instance.
Id of fault group.
Id of fault.
Indicates a forced move.
Shows there is existing related events available.
Polymorphic Discriminator
The name of a Service Fabric node.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Service name.
The time event was logged.
Chaos Move Secondary Fault Scheduled event.
The category of event.
The name of a Service Fabric node.
The identifier for the FabricEvent instance.
Id of fault group.
Id of fault.
Indicates a forced move.
Shows there is existing related events available.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Service name.
The name of a Service Fabric node.
The time event was logged.
Chaos Remove Replica Fault Scheduled event.
The category of event.
The identifier for the FabricEvent instance.
Id of fault group.
Id of fault.
Shows there is existing related events available.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Service name.
The time event was logged.
Chaos Restart Replica Fault Scheduled event.
The category of event.
The identifier for the FabricEvent instance.
Id of fault group.
Id of fault.
Shows there is existing related events available.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Service name.
The time event was logged.
Defines the schedule used by Chaos.
A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.
The date and time Chaos will continue to use this schedule until. Default value: new Date('9999-12-31T23:59:59.999Z').
A list of all Chaos Schedule Jobs that will be automated by the schedule.
The date and time Chaos will start using this schedule. Default value: new Date('1601-01-01T00:00:00Z').
Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.
Defines the schedule used by Chaos.
The version number of the Schedule.
Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.
A reference to which Chaos Parameters of the Chaos Schedule to use.
Defines the days of the week that a Chaos Schedule Job will run for.
A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.
Defines the days of the week that a Chaos Schedule Job will run for.
Indicates if the Chaos Schedule Job will run on Friday. Default value: false.
Indicates if the Chaos Schedule Job will run on Monday. Default value: false.
Indicates if the Chaos Schedule Job will run on Saturday. Default value: false.
Indicates if the Chaos Schedule Job will run on Sunday. Default value: false.
Indicates if the Chaos Schedule Job will run on Thursday. Default value: false.
Indicates if the Chaos Schedule Job will run on Tuesday. Default value: false.
Indicates if the Chaos Schedule Job will run on Wednesday. Default value: false.
Chaos Started event.
The category of event.
Chaos Context.
Health policy.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
List of included Applications.
List of included Node types.
Polymorphic Discriminator
Maximum timeout for cluster stabilization in seconds.
Maximum number of concurrent faults.
Indicates MoveReplica fault is enabled.
The time event was logged.
Time to run in seconds.
Wait time between faults in seconds.
Wait time between iterations in seconds.
Chaos Stopped event.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Describes reason.
The time event was logged.
Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications. If ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection of NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify "fault this application only when it is on that node type." Once an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if applicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included in NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.
A list of application URIs to include in Chaos faults. All replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos. Chaos may restart a code package only if the code package hosts replicas of these applications only. If an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList. However, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted. At most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.
A list of node types to include in Chaos faults. All types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types. If a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of NodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList. happens to reside on a node of NodeTypeX. At most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.
Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument. The PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument. The CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
Whether or not the property should exist for the operation to pass.
Polymorphic Discriminator
The name of the Service Fabric property.
Compares the Sequence Number of a property with the SequenceNumber argument. A property's sequence number can be thought of as that property's version. Every time the property is modified, its sequence number is increased. The sequence number can be found in a property's metadata. The comparison fails if the sequence numbers are not equal. CheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
Polymorphic Discriminator
The name of the Service Fabric property.
The expected sequence number.
Represents a PropertyBatchOperation that compares the value of the property with the expected value. The CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
Polymorphic Discriminator
The name of the Service Fabric property.
The expected property value.
Information about the standalone cluster configuration.
The contents of the cluster configuration file.
Describes the parameters for a standalone cluster configuration upgrade.
Defines the application health policy map used to evaluate the health of an application or one of its children entities.
The cluster configuration as a JSON string. For example, this file contains JSON describing the nodes and other properties of the cluster.
The length of time between attempts to perform health checks if the application or cluster is not healthy. Default value: 'PT0H0M0S'.
The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. Default value: 'PT0H0M0S'.
The length of time to wait after completing an upgrade domain before starting the health checks process. Default value: 'PT0H0M0S'.
The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.
The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.
The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.
The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100. Default value: 0.
The timeout for the upgrade domain. Default value: 'PT0H0M0S'.
The upgrade timeout. Default value: 'PT0H0M0S'.
Information about a standalone cluster configuration upgrade status.
The cluster configuration version.
The cluster upgrade status details.
The cluster manifest version.
The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'
Represents the base for all Cluster Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Cluster application health states as found in the health store.
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Cluster node health states as found in the health store.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter.
The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
The HealthState representing the aggregated health state of the cluster computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired cluster health policy and the application health policies. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description.
The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.
Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.
Defines the application health policy map used to evaluate the health of an application or one of its children entities.
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.
Health policies to evaluate cluster health.
Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.
The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.
Indicates whether warnings are treated with the same severity as errors. Default value: false.
The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.
The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. Default value: 0.
The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.
The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.
In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. Default value: 0.
Cluster Health Report Expired event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.
The end time of last resource balancing run.
The starting time of last resource balancing run.
List that contains metrics and their load information in this cluster.
Information about the cluster manifest.
The contents of the cluster manifest file.
Cluster Health Report Created event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Cluster Upgrade Completed event.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Overall duration of upgrade in milli-seconds.
Target Cluster version.
The time event was logged.
Represents a ServiceFabric cluster upgrade
Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
The ServiceFabric code version of the cluster.
The cluster configuration version (specified in the cluster manifest).
When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
Describes the parameters for monitoring an upgrade in Monitored mode.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.
The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
Cluster Upgrade Domain Completed event.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Target Cluster version.
The time event was logged.
Duration of domain upgrade in milli-seconds.
Upgrade domains.
State of upgrade.
Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.
The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.
Information about a cluster upgrade.
The ServiceFabric code version of the cluster.
The cluster configuration version (specified in the cluster manifest).
Information about the current in-progress upgrade domain.
The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'
The failure time of the upgrade in UTC.
The name of the next upgrade domain to be processed.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
The start time of the upgrade in UTC.
List of health evaluations that resulted in the current aggregated health state.
Represents a ServiceFabric cluster upgrade
The estimated elapsed time spent processing the current upgrade domain.
The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.
List of upgrade domains and their statuses.
The estimated elapsed time spent processing the current overall upgrade.
The state of the upgrade domain. Possible values include: 'Invalid', 'RollingBackInProgress', 'RollingBackCompleted', 'RollingForwardPending', 'RollingForwardInProgress', 'RollingForwardCompleted', 'Failed'
Cluster Upgrade Rollback Completed event.
The category of event.
The identifier for the FabricEvent instance.
Describes failure.
Shows there is existing related events available.
Polymorphic Discriminator
Overall duration of upgrade in milli-seconds.
Target Cluster version.
The time event was logged.
Cluster Upgrade Rollback Started event.
The category of event.
The identifier for the FabricEvent instance.
Describes failure.
Shows there is existing related events available.
Polymorphic Discriminator
Overall duration of upgrade in milli-seconds.
Target Cluster version.
The time event was logged.
Cluster Upgrade Started event.
The category of event.
Current Cluster version.
The identifier for the FabricEvent instance.
Action if failed.
Shows there is existing related events available.
Polymorphic Discriminator
Mode of upgrade.
Target Cluster version.
The time event was logged.
Type of upgrade.
The cluster version.
The Service Fabric cluster runtime version.
Information about setup or main entry point of a code package deployed on a Service Fabric node.
Statistics about setup or main entry point of a code package deployed on a Service Fabric node.
The location of entry point executable on the node.
The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change.
The time (in UTC) when the entry point executable will be run next.
The process ID of the entry point.
The user name under which entry point executable is run on the node.
Specifies the status of the code package entry point deployed on a Service Fabric node. Possible values include: 'Invalid', 'Pending', 'Starting', 'Started', 'Stopping', 'Stopped'
Statistics about setup or main entry point of a code package deployed on a Service Fabric node.
Number of times the entry point has run.
Number of times the entry point failed to run.
Number of times the entry point continuously failed to run.
Number of times the entry point continuously failed to exit gracefully.
Number of times the entry point finished running.
Number of times the entry point failed to exit gracefully.
The last time (in UTC) when Service Fabric attempted to run the entry point.
The last exit code of the entry point.
The last time (in UTC) when the entry point finished running.
The last time (in UTC) when the entry point ran successfully.
The last time (in UTC) when the entry point finished running gracefully.
Information about a Service Fabric compose deployment.
The name of the application, including the 'fabric:' URI scheme.
The name of the deployment.
The status of the compose deployment. Possible values include: 'Invalid', 'Provisioning', 'Creating', 'Ready', 'Unprovisioning', 'Deleting', 'Failed', 'Upgrading'
The status details of compose deployment including failure message.
Describes the parameters for a compose deployment upgrade.
Defines a health policy used to evaluate the health of an application or one of its children entities.
The content of the compose file that describes the deployment to create.
The name of the deployment.
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
Describes the parameters for monitoring an upgrade in Monitored mode.
Credential information to connect to container registry.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
Describes the parameters for a compose deployment upgrade.
Defines a health policy used to evaluate the health of an application or one of its children entities.
The name of the target application, including the 'fabric:' URI scheme.
List of health evaluations that resulted in the current aggregated health state.
Additional details of application upgrade including failure message.
The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
Information about the current in-progress upgrade domain.
The name of the target deployment.
The cause of an upgrade failure that resulted in FailureAction being executed. Possible values include: 'None', 'Interrupted', 'HealthCheck', 'UpgradeDomainTimeout', 'OverallUpgradeTimeout'
The estimated UTC datetime when the upgrade failed and FailureAction was executed.
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
Describes the parameters for monitoring an upgrade in Monitored mode.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
The estimated UTC datetime when the upgrade started.
The target application type version (found in the application manifest) for the application upgrade.
Information about the upgrade domain progress at the time of upgrade failure.
The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
The state of the compose deployment upgrade. Possible values include: 'Invalid', 'ProvisioningTarget', 'RollingForwardInProgress', 'RollingForwardPending', 'UnprovisioningCurrent', 'RollingForwardCompleted', 'RollingBackInProgress', 'UnprovisioningTarget', 'RollingBackCompleted', 'Failed'
Additional detailed information about the status of the pending upgrade.
parameters for making container API call.
HTTP request body of container REST API
Content type of container REST API request, defaults to "application/json"
HTTP verb of container REST API, defaults to "GET"
URI path of container REST API
Response body that wraps container API result.
Container API result.
Container API result.
container API result body
HTTP content encoding
HTTP content type
HTTP status code returned by the target container API
Describes a container and its runtime properties.
Command array to execute within the container in exec form.
Reference to sinks in DiagnosticsDescription.
The endpoints exposed by this container.
Override for the default entry point in the container.
The environment variables to set in this container
The Container image to use.
Image registry credential.
Runtime information of a container instance. NOTE: This property will not be serialized. It can only be populated by the server.
The labels to set in this container.
The name of the code package.
A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.
The resources required by this container.
The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".
Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.
Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.
A container event.
The count of the event.
Date/time of the first event.
Date/time of the last event.
The event message
The name of the container event.
The event type.
Represents the base for all Container Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Runtime information of a container instance.
Current container instance state.
The events of this container instance.
Previous container instance state.
The number of times the container has been restarted.
Describes a container label.
The name of the container label.
The value of the container label.
Container logs.
Container logs.
The container state.
Human-readable status of this state.
The container exit code.
Date/time when the container state finished.
Date/time when the container state started.
The state of this container
Defines description for creating a Service Fabric compose deployment.
The content of the compose file that describes the deployment to create.
The name of the deployment.
Credential information to connect to container registry.
Information about the current in-progress upgrade domain.
The name of the upgrade domain
List of upgrading nodes and their statuses
Describes the intent or reason for deactivating the node.
Describes the intent or reason for deactivating the node. The possible values are following. Possible values include: 'Pause', 'Restart', 'RemoveData'
Represents a PropertyBatchOperation that deletes a specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
Polymorphic Discriminator
The name of the Service Fabric property.
Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.
Total number of nodes in the health store at the beginning of the cluster upgrade.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy.
Total number of nodes in the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.
The application type name as defined in the application manifest.
The version of the application type as defined in the application manifest.
The name of a Service Fabric node.
List of package sharing policy information.
The name of service manifest whose packages need to be downloaded.
Information about the health of an application deployed on a Service Fabric node.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Deployed service package health states for the current deployed application as found in the health store.
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Name of the application deployed on the node whose health information is described by this object.
Name of the node where this application is deployed.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Name of the node where the application is deployed to.
List of unhealthy evaluations that led to the current aggregated health state of the deployed application. The types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation.
Deployed Application Health Report Expired event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Id of Application instance.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
The name of a Service Fabric node.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
Name of the node on which the service package is deployed.
Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.
The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of node where the application is deployed.
The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
The list of deployed application health state chunks that respect the input filters in the chunk query.
Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple deployed applications, depending on its properties.
Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter. If the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters. The deployed application filter may specify multiple deployed service package filters. For example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node.
The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).
The name of the node where the application is deployed in order to match the filter. If specified, the filter is applied only to the application deployed on the specified node. If the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter. Otherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
Information about application deployed on the node.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The log directory of the application on the node. The log directory can be used to store application logs.
The name of the application, including the 'fabric:' URI scheme.
The status of the application deployed on the node. Following are the possible values. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'
The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory.
The application type name as defined in the application manifest.
The work directory of the application on the node. The work directory can be used to store application data.
Deployed Application Health Report Created event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
Id of Application instance.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
The name of a Service Fabric node.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy.
Total number of deployed applications of the application in the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health.
Information about code package deployed on a Service Fabric node.
Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest. Possible values include: 'None', 'Process', 'HyperV'
Specifies the type of host for main entry point of a code package as specified in service manifest. Possible values include: 'Invalid', 'ExeHost', 'ContainerHost'
Information about setup or main entry point of a code package deployed on a Service Fabric node.
The name of the code package.
The interval at which code package is run. This is used for periodic code package.
The name of service manifest that specified this code package.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Information about setup or main entry point of a code package deployed on a Service Fabric node.
Specifies the status of a deployed application or service package on a Service Fabric node. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'
The version of the code package specified in service manifest.
Information about the health of a service package for a specific application deployed on a Service Fabric node.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Name of the node where this service package is deployed.
Name of the service manifest.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
The name of a Service Fabric node.
The name of the service manifest.
List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation.
Deployed Service Health Report Expired event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
The name of a Service Fabric node.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Service manifest name.
Id of Service package activation.
Id of Service package instance.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the application, including the 'fabric:' URI scheme.
Name of the node on which the service package is deployed.
Name of the manifest describing the service package.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of the service manifest.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
The list of deployed service package health state chunks that respect the input filters in the chunk query.
Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk. The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk. One filter can match zero, one or multiple deployed service packages, depending on its properties.
The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states. The possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state. If not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).
The name of the service manifest which identifies the deployed service packages that matches the filter. If specified, the filter is applied only to the specified deployed service packages, if any. If no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter. If any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties. If not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
The activation ID of a deployed service package that matches the filter. If not specified, the filter applies to all deployed service packages that match the other parameters. If specified, the filter matches only the deployed service package with the specified activation ID.
Information about service package deployed on a Service Fabric node.
The name of the service package as specified in the service manifest.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Specifies the status of a deployed application or service package on a Service Fabric node. Possible values include: 'Invalid', 'Downloading', 'Activating', 'Active', 'Upgrading', 'Deactivating'
The version of the service package specified in service manifest.
Deployed Service Health Report Created event.
The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
The name of a Service Fabric node.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Service manifest name.
Id of Service package activation.
Id of Service package instance.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Total number of deployed service packages of the deployed application in the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health.
Information about a Service Fabric service replica deployed on a node.
Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'
The start time of the current service operation in UTC format.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
List of load reported by replica.
Polymorphic Discriminator
Full hierarchical name of the service in URI format starting with fabric:.
Information about a Service Fabric service replica deployed on a node.
The last address returned by the replica in Open or ChangeRole.
The name of the code package that hosts this replica.
Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Polymorphic Discriminator
The name of the service manifest in which this service type is defined.
The full name of the service with 'fabric:' URI scheme.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Name of the service type as specified in the service manifest.
Information about service type deployed on a node, information such as the status of the service type registration on a node.
The name of the code package that registered the service type.
The name of the service manifest in which this service type is defined.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Name of the service type as specified in the service manifest.
The status of the service type registration on the node. Possible values include: 'Invalid', 'Disabled', 'Enabled', 'Registered'
Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.
Specifies the operation currently being executed by the Replicator. Possible values include: 'Invalid', 'None', 'Open', 'ChangeRole', 'UpdateEpoch', 'Close', 'Abort', 'OnDataLoss', 'WaitForCatchup', 'Build'
Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'
The start time of the current service operation in UTC format.
Information about a stateful service replica deployed on a node.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Specifies the access status of the partition. Possible values include: 'Invalid', 'Granted', 'ReconfigurationPending', 'NotPrimary', 'NoWriteQuorum'
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Key value store related information for the replica.
Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.
List of load reported by replica.
Polymorphic Discriminator
Full hierarchical name of the service in URI format starting with fabric:.
Specifies the access status of the partition. Possible values include: 'Invalid', 'Granted', 'ReconfigurationPending', 'NotPrimary', 'NoWriteQuorum'
Information about a stateful service replica deployed on a node.
The last address returned by the replica in Open or ChangeRole.
The name of the code package that hosts this replica.
Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
The role of a replica of a stateful service. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Polymorphic Discriminator
The name of the service manifest in which this service type is defined.
The full name of the service with 'fabric:' URI scheme.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Name of the service type as specified in the service manifest.
Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.
Specifies the current active life-cycle operation on a stateful service replica or stateless service instance. Possible values include: 'Unknown', 'None', 'Open', 'ChangeRole', 'Close', 'Abort'
The start time of the current service operation in UTC format.
Information about a stateless service instance deployed on a node.
Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
List of load reported by replica.
Polymorphic Discriminator
Full hierarchical name of the service in URI format starting with fabric:.
Information about a stateless service instance deployed on a node.
The last address returned by the replica in Open or ChangeRole.
The name of the code package that hosts this replica.
Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Polymorphic Discriminator
The name of the service manifest in which this service type is defined.
The full name of the service with 'fabric:' URI scheme.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Name of the service type as specified in the service manifest.
Describes the diagnostics options available
The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.
Status of whether or not sinks are enabled.
List of supported sinks that can be referenced.
Reference to sinks in DiagnosticsDescription.
Status of whether or not sinks are enabled.
List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.
Properties of a DiagnosticsSink.
A description of the sink.
Polymorphic Discriminator
Name of the sink. This value is referenced by DiagnosticsReferenceDescription
It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).
Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup.
Describes a Service Fabric property value of type Double.
The data of the property value.
Polymorphic Discriminator
Specifies the parameters needed to enable periodic backup.
Name of the backup policy to be used for enabling periodic backups.
Describes a container endpoint.
The name of the endpoint.
Port used by the container.
Describes a reference to a service endpoint.
Name of the endpoint.
Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Safety check that ensures that a quorum of replicas are not lost for a partition.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
A base type for the health state of various entities in the cluster. It contains the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.
Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
Represents health state count for entities of the specified entity kind.
The entity kind for which health states are evaluated. Possible values include: 'Invalid', 'Node', 'Partition', 'Service', 'Application', 'Replica', 'DeployedApplication', 'DeployedServicePackage', 'Cluster'
The health state count for the entities of the specified kind.
Describes an environment variable for the container.
The name of the environment variable.
The value of the environment variable.
An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.
The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes.
The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica.
Represents health evaluation of a HealthEvent that was reported on the entity. The health evaluation is returned when evaluating health of an entity results in Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.
List of string description of the faults that Chaos decided to execute in an iteration.
Polymorphic Discriminator
The UTC timestamp when this Chaos event was generated.
Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.
The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.
The application type name represents the name of the application type found in the application manifest.
The application type version represents the version of the application type found in the application manifest.
Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.
Polymorphic Discriminator
Information about a Service Fabric code version.
The product version of Service Fabric.
Information about a Service Fabric config version.
The config version of Service Fabric.
The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
Error object containing error code and error message.
Error object containing error code and error message.
Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.
"E_INVALIDARG"
Possible values of the error code for HTTP status code 404 (Not Found)
"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR"
Possible values of the error code for HTTP status code 409 (Conflict)
"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING"
Possible values of the error code for HTTP status code 413 (Request Entity Too Large)
"FABRIC_E_VALUE_TOO_LARGE"
Possible values of the error code for HTTP status code 500 (Internal Server Error)
"SerializationError"
Possible values of the error code for HTTP status code 503 (Service Unavailable)
"FABRIC_E_VALUE_TOO_LARGE"
Possible values of the error code for HTTP status code 504 (Gateway Timeout)
Error message.
Represents the base for all Fabric Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The time event was logged.
Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.
The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch.
Polymorphic Discriminator
The index of the unsuccessful operation in the property batch.
The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.
The name of the upgrade domain
List of upgrading nodes and their statuses
Information about the upgrade domain progress at the time of upgrade failure.
The name of the upgrade domain
List of upgrading nodes and their statuses
Information about a image store file.
The size of file in bytes.
Information about the version of image store file.
The date and time when the image store file was last modified.
The file path relative to the image store root path.
Describes the parameters for file share storage used for storing or enumerating backups.
Friendly name for this backup storage.
UNC path of the file share where to store or enumerate backups from.
Primary password to access the share location.
Primary user name to access the file share.
Secondary password to access the share location
Secondary user name to access the file share.
Polymorphic Discriminator
Information about the version of image store file.
The epoch configuration version number of the image store replica when this file entry was created or updated.
The epoch data loss number of image store replica when this file entry was updated or created.
The current image store version number for the file is used in image store for checking whether it need to be updated.
Information about a image store folder. It includes how many files this folder contains and its image store relative path.
The number of files from within the image store folder.
The remote location within image store. This path is relative to the image store root.
Information of a image store folder size
The size of folder in bytes.
The remote location within image store. This path is relative to the image store root.
Describes the frequency based backup schedule.
Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy.
Polymorphic Discriminator
Describes destination endpoint for routing traffic.
Name of the service fabric Mesh application.
name of the endpoint in the service.
service that contains the endpoint.
This type describes a gateway resource.
User readable description of the gateway.
Network that the Application is using.
Configuration for http connectivity for this gateway.
IP address of the gateway. This is populated in the response and is ignored for incoming requests. NOTE: This property will not be serialized. It can only be populated by the server.
Name of the Gateway resource.
Network the gateway should listen on for requests.
Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the gateway. NOTE: This property will not be serialized. It can only be populated by the server.
Configuration for tcp connectivity for this gateway.
Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.
Indicates the entity for which to enumerate backups.
Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end.
If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. Default value: false.
Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning.
Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore.
Represents a PropertyBatchOperation that gets the specified property if it exists. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
Whether or not to return the property value with the metadata. True if values should be returned with the metadata; False to return only property metadata. Default value: false.
Polymorphic Discriminator
The name of the Service Fabric property.
Describes a Service Fabric property value of type Guid.
The data of the property value.
Polymorphic Discriminator
Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Wrapper object for health evaluation.
Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Returns true if the health event is expired, otherwise false.
If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.
If the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.
If the health state was never 'Error', the value will be zero date-time.
The date and time when the health report was last modified by the health store.
If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'. For periodic reporting, many reports with the same state may have been generated. This property returns the date and time when the first 'Ok' health report was received.
If the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.
If the health state was never 'Ok', the value will be zero date-time.
If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.
If the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.
If the health state was never 'Warning', the value will be zero date-time.
The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node.
Together with the SourceId, the property uniquely identifies the health information.
Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.
The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.
The source name that identifies the client/watchdog/system component that generated the health information.
The date and time when the health report was sent by the source.
The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.
If not specified, time to live defaults to infinite value.
Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.
The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node.
Together with the SourceId, the property uniquely identifies the health information.
Value that indicates whether the report is removed from health store when it expires. If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state.
The sequence number for this health report as a numeric string. The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added.
The source name that identifies the client/watchdog/system component that generated the health information.
The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.
If not specified, time to live defaults to infinite value.
Represents information about how many health entities are in Ok, Warning and Error health state.
The number of health entities with aggregated health state Error.
The number of health entities with aggregated health state Ok.
The number of health entities with aggregated health state Warning.
The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics. The statistics include health state counts for all children types of the current entity. For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages. For partition, the health statistics include health counts for replicas.
List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state.
Describes the http configuration for external connectivity for this network.
description for routing.
http gateway config name.
Specifies the port at which the service endpoint below needs to be exposed.
Describes the hostname properties for http routing.
http hostname config name.
Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.
Describes the hostname properties for http routing.
Describes destination endpoint for routing traffic.
Describes a rule for http route matching.
http route name.
Describes header information for http route matching.
Name of header to match in request.
Value of header to match in request.
how to match header value. Possible values include: 'exact'
Path to match for routing.
replacement string for matched part of the Uri.
Uri path to match for request.
Describes a rule for http route matching.
headers and their values to match in request.
Path to match for routing.
Information describing the identities associated with this application.
the object identifier of the Service Principal of the identity associated with this resource.
the identifier of the tenant containing the application's identity.
the endpoint for the token service managing this identity
represents user assigned identities map.
the types of identities associated with this resource; currently restricted to 'SystemAssigned and UserAssigned'
Describes a single user-assigned identity associated with the application.
the client identifier of the Service Principal which this identity represents.
the object identifier of the Service Principal which this identity represents.
Image registry credential.
The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations.
Docker image registry server, without protocol such as http and https.
The username for the private registry.
Information about the image store content.
The list of image store file info objects represents files found under the given image store relative path.
The list of image store folder info objects represents subfolders found under the given image store relative path.
Information about how to copy image store content from one image store relative path to another image store relative path.
Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped.
The relative path of destination image store content to be copied to.
The relative path of source image store content to be copied from.
The list of the file names to be skipped for copying.
Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.
The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed.
User readable description of the secret.
Polymorphic Discriminator
Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the secret. NOTE: This property will not be serialized. It can only be populated by the server.
Describes a Service Fabric property value of type Int64.
The data of the property value.
Polymorphic Discriminator
Describes the partition information for the integer range that is based on partition schemes.
Specifies the maximum key value handled by this partition.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Specifies the minimum key value handled by this partition.
Polymorphic Discriminator
Represents information about an operation in a terminal state (Completed or Faulted).
If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
This class returns information about the partition that the user-induced operation acted upon.
Represents information about an operation in a terminal state (Completed or Faulted).
If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
This class returns information about the partition that the user-induced operation acted upon.
Key value store related information for the replica.
Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback.
Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback.
Value indicating the estimated size of the underlying database.
Value indicating the estimated number of rows in the underlying database.
Polymorphic Discriminator
Value indicating the current status details of the replica.
Represents data structure that contains load information for a certain metric in a cluster.
The current action being taken with regard to this metric
The Activity Threshold specified for this metric in the system Cluster Manifest.
The balancing threshold for a certain metric.
Remaining capacity in the cluster excluding the reserved space.
Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.
The total cluster capacity for a given metric
The remaining capacity for the metric in the cluster.
The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.
The remaining percentage of cluster total capacity for this metric.
The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.
The total cluster load.
The standard average deviation of the metrics after resource balancer run.
The standard average deviation of the metrics before resource balancer run.
Value that indicates whether the metrics is balanced or not after resource balancer run.
Value that indicates whether the metrics is balanced or not before resource balancer run
Indicates that the metric is currently over capacity in the cluster.
The node id of the node with the maximum load for this metric.
The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.
The maximum load on any node for this metric.
The node id of the node with the minimum load for this metric.
The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.
The minimum load on any node for this metric.
Name of the metric for which this load information is provided.
The reserved percentage of total node capacity for this metric.
This value represents the load of the replicas that are planned to be removed in the future within the cluster. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.
Represents the load metric report which contains the time metric was reported, its name and value.
The value of the load metric.
Gets the UTC time when the load was reported.
The name of the load metric.
The value of the load metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.
Information about load reported by replica.
The double value of the load for the metric.
The UTC time when the load is reported.
The name of the metric.
The value of the load for the metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.
Information about a Service Fabric container network local to a single Service Fabric cluster.
User readable description of the network.
Polymorphic Discriminator
Address space for the local container network.
Status of the network. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the network. NOTE: This property will not be serialized. It can only be populated by the server.
Describes a managed application identity.
The name of the identity.
The identity's PrincipalId.
Managed application identity description.
A list of managed application identity objects.
Token service endpoint.
Describes the parameters for monitoring an upgrade in Monitored mode.
The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: 'Invalid', 'Rollback', 'Manual'
The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
Describes a Service Fabric name.
The Service Fabric name, including the 'fabric:' URI scheme.
Describes the partition information for the name as a string that is based on partition schemes.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Name of the partition.
Polymorphic Discriminator
Describes the named partition scheme of the service.
The number of partitions.
Array of size specified by the ‘Count’ parameter, for the names of the partitions.
Polymorphic Discriminator
Describes a network reference in a service.
A list of endpoints that are exposed on this network.
Name of the network
This type describes a network resource.
Name of the Network resource.
Describes properties of a network resource.
Describes properties of a network resource.
User readable description of the network.
Polymorphic Discriminator
Status of the network. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the network. NOTE: This property will not be serialized. It can only be populated by the server.
This type describes the properties of a network resource, including its kind.
Polymorphic Discriminator
Node Aborted event.
The category of event.
The identifier for the FabricEvent instance.
Fault domain of Node.
Shows there is existing related events available.
Name of Host.
IP address or FQDN.
Indicates if it is seed node.
Polymorphic Discriminator
Id of Node.
Id of Node instance.
The name of a Service Fabric node.
Version of Node.
The time event was logged.
Upgrade domain of Node.
Node Added event.
The category of event.
The identifier for the FabricEvent instance.
Fabric version.
Shows there is existing related events available.
IP address or FQDN.
Polymorphic Discriminator
Capacities.
Id of Node.
Id of Node instance.
The name of a Service Fabric node.
Type of Node.
The time event was logged.
Node Closed event.
The category of event.
Describes error.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Id of Node.
Id of Node instance.
The name of a Service Fabric node.
The time event was logged.
Node Deactivate Completed event.
Batch Ids.
The category of event.
Describes deactivate intent.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Id of Node instance.
The name of a Service Fabric node.
Start time.
The time event was logged.
Node Deactivate Started event.
Batch Id.
The category of event.
Describes deactivate intent.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Id of Node instance.
The name of a Service Fabric node.
The time event was logged.
Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
The intent or the reason for deactivating the node. Following are the possible values for it. Possible values include: 'Invalid', 'Pause', 'Restart', 'RemoveData', 'RemoveNode'
The status of node deactivation operation. Following are the possible values. Possible values include: 'None', 'SafetyCheckInProgress', 'SafetyCheckComplete', 'Completed'
List of tasks representing the deactivation operation on the node.
List of pending safety checks
The task representing the deactivation operation on the node.
The intent or the reason for deactivating the node. Following are the possible values for it. Possible values include: 'Invalid', 'Pause', 'Restart', 'RemoveData', 'RemoveNode'
Identity of the task related to deactivation operation on the node.
Identity of the task related to deactivation operation on the node.
Value of the task id.
The type of the task that performed the node deactivation. Following are the possible values. Possible values include: 'Invalid', 'Infrastructure', 'Repair', 'Client'
Node Down event.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Time when Node was last up.
Id of Node instance.
The name of a Service Fabric node.
The time event was logged.
Represents the base for all Node Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The name of a Service Fabric node.
The time event was logged.
Information about the health of a Service Fabric node.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Name of the node whose health information is described by this object.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
The name of a Service Fabric node.
List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation.
Node Health Report Expired event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
Id of Node instance.
The name of a Service Fabric node.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents the health state of a node, which contains the node identifier and its aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
The name of a Service Fabric node.
Represents the health state chunk of a node, which contains the node name and its aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The name of a Service Fabric node.
The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
The list of node health state chunks that respect the input filters in the chunk query.
Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes, depending on its properties. Can be specified in the cluster health chunk query description.
The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states. The possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).
Name of the node that matches the filter. The filter is applied only to the specified node, if it exists. If the node doesn't exist, no node is returned in the cluster health chunk based on this filter. If the node exists, it is included in the cluster health chunk if the health state matches the other filter properties. If not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
Value of the node Id. This is a 128 bit integer.
Describes the expected impact of a repair to a particular node.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
The level of impact expected. Possible values include: 'Invalid', 'None', 'Restart', 'RemoveData', 'RemoveNode'
The name of the impacted node.
Information about a node in Service Fabric cluster.
The version of Service Fabric binaries that the node is running.
The version of Service Fabric cluster manifest that the node is using.
The fault domain of the node.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.
The IP address or fully qualified domain name of the node.
Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.
Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.
The name of a Service Fabric node.
Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.
Date time in UTC when the node went down. If node has never been down then this value will be zero date time.
Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.
The status of the node. Possible values include: 'Invalid', 'Up', 'Down', 'Enabling', 'Disabling', 'Disabled', 'Unknown', 'Removed'
Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.
Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.
The upgrade domain of the node.
The type of the node.
Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.
List that contains metrics and their load information on this node.
Name of the node for which the load information is provided by this object.
Represents data structure that contains load information for a certain metric on a node.
The remaining capacity which is not reserved by NodeBufferPercentage for this metric on the node.
Current load on the node for this metric.
Indicates if there is a capacity violation for this metric on the node.
Name of the metric for which this load information is provided.
The value that indicates the reserved capacity for this metric on the node.
Total capacity on the node for this metric.
The remaining capacity on the node for the metric.
Current load on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentNodeLoad.
The remaining reserved capacity for this metric on the node. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedNodeCapacityRemaining.
The remaining capacity on the node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of NodeCapacityRemaining.
This value represents the load of the replicas that are planned to be removed in the future. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.
Node Health Report Created event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
Id of Node instance.
The name of a Service Fabric node.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Node Open Failed event.
The category of event.
Describes the error.
The identifier for the FabricEvent instance.
Fault domain of Node.
Shows there is existing related events available.
Name of Host.
IP address or FQDN.
Indicates if it is seed node.
Polymorphic Discriminator
Id of Node.
Id of Node instance.
The name of a Service Fabric node.
Version of Node.
The time event was logged.
Upgrade domain of Node.
Node Opened Succeeded event.
The category of event.
The identifier for the FabricEvent instance.
Fault domain of Node.
Shows there is existing related events available.
Name of Host.
IP address or FQDN.
Indicates if it is seed node.
Polymorphic Discriminator
Id of Node.
Id of Node instance.
The name of a Service Fabric node.
Version of Node.
The time event was logged.
Upgrade domain of Node.
Node Removed event.
The category of event.
The identifier for the FabricEvent instance.
Fabric version.
Shows there is existing related events available.
IP address or FQDN.
Polymorphic Discriminator
Capacities.
Id of Node.
Id of Node instance.
The name of a Service Fabric node.
Type of Node.
The time event was logged.
Describes the expected impact of a repair on a set of nodes.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
Polymorphic Discriminator
The list of nodes impacted by a repair action and their respective expected impact.
Describes the list of nodes targeted by a repair action.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
Polymorphic Discriminator
The list of nodes targeted by a repair action.
Contains information about a node that was targeted by a user-induced operation.
The node instance id.
The name of a Service Fabric node.
Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState is Completed or Faulted.
Represents information about an operation in a terminal state (Completed or Faulted).
The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'
Represents information about an operation in a terminal state (Completed or Faulted).
If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
Contains information about a node that was targeted by a user-induced operation.
Node Up event.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Time when Node was last down.
Id of Node instance.
The name of a Service Fabric node.
The time event was logged.
Information about the upgrading node and its status
The name of a Service Fabric node.
List of pending safety checks
The state of the upgrading node. Possible values include: 'Invalid', 'PreUpgradeSafetyCheck', 'Upgrading', 'PostUpgradeSafetyCheck'
Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.
Total number of nodes found in the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
Contains the OperationId, OperationState, and OperationType for user-induced operations.
A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API.
The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'
The type of the operation. Possible values include: 'Invalid', 'PartitionDataLoss', 'PartitionQuorumLoss', 'PartitionRestart', 'NodeTransition'
Represents a policy for the package sharing.
Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation. Possible values include: 'None', 'All', 'Code', 'Config', 'Data'
The name of code, configuration or data package that should be shared.
The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of application information.
The list of application resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of application type information.
The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of backup configuration information.
The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of backup entity information.
The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of backup information.
The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
The list of backup policies information.
The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of compose deployment status information.
The list of deployed applications in activating, downloading, or active states on a node. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of deployed application information.
The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
The list of network resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of node information.
The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false.
List of property information.
The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of replica information.
The list of secret resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
The list of values of a secret resource, paged if the number of results exceeds the limits of a single message. The next set of results can be obtained by executing the same query with the continuation token provided in the previous page.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of service information.
The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of service partition information.
The list of service resource replicas in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
List of service resource replica description.
The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false.
List of the child names.
The list of volume resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
One page of the list.
Represents the base for all Partition Analysis Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Metadata about an Analysis Event.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The time event was logged.
Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.
Polymorphic Discriminator
The partition ID identifying the partition.
Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
The name of the backup policy which is applicable to this Service Fabric application or service or partition.
The full name of the service with 'fabric:' URI scheme.
Describes the backup suspension details.
Identifies the Service Fabric stateful partition which is being backed up.
Polymorphic Discriminator
The partition ID identifying the partition.
The full name of the service with 'fabric:' URI scheme.
Information about a partition data loss user-induced operation.
Represents information about an operation in a terminal state (Completed or Faulted).
The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'
Represents the base for all Partition Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The time event was logged.
Information about the health of a Service Fabric partition.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
ID of the partition whose health information is described by this object.
The list of replica health states associated with the partition.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Id of the partition whose health evaluation is described by this object.
List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation.
Partition Health Report Expired event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents the health state of a partition, which contains the partition identifier and its aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Id of the partition whose health state is described by this object.
Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The Id of the partition.
The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description.
The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as part of the parent application hierarchy.
The list of partition health state chunks that respect the input filters in the chunk query.
Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk. One filter can match zero, one or multiple partitions, depending on its properties.
The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states. The possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).
ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists. If the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter. If the partition exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter. If the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters. The partition filter may specify multiple replica filters. For example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id.
Information about the partition identity, partitioning scheme and keys supported by it.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Polymorphic Discriminator
Represents a scaling mechanism for adding or removing instances of stateless service partition.
Polymorphic Discriminator
Maximum number of instances of the partition.
Minimum number of instances of the partition.
The number of instances to add or remove during a scaling operation.
Represents load information for a partition, which contains the primary and secondary reported load metrics. In case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition. For default loads, LoadMetricReport's LastReportedUtc is set to 0.
Id of the partition.
Array of load reports from the primary replica for this partition.
Array of aggregated load reports from all secondary replicas for this partition. Array only contains the latest reported load for each metric.
Partition Health Report Created event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Partition Primary Move Analysis event.
The category of event.
The name of a Service Fabric node.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Metadata about an Analysis Event.
Move reason.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The name of a Service Fabric node.
Relevant traces.
The time event was logged.
Time when the move was completed.
Information about a partition quorum loss user-induced operation.
Represents information about an operation in a terminal state (Completed or Faulted).
The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'
Partition Reconfiguration event.
The category of event.
CcEpochConfig version.
CcEpochDataLoss version.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
Id of Node instance.
The name of a Service Fabric node.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Duration of Phase0 in milli-seconds.
Duration of Phase1 in milli-seconds.
Duration of Phase2 in milli-seconds.
Duration of Phase3 in milli-seconds.
Duration of Phase4 in milli-seconds.
Type of reconfiguration.
Describes reconfiguration result.
Type of Service.
The time event was logged.
Total duration in milli-seconds.
Information about a partition restart user-induced operation.
Represents information about an operation in a terminal state (Completed or Faulted).
The state of the operation. Possible values include: 'Invalid', 'Running', 'RollingBack', 'Completed', 'Faulted', 'Cancelled', 'ForceCancelled'
Represents a safety check for the service partition being performed by service fabric before continuing with operations.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Describes how the service is partitioned.
Polymorphic Discriminator
Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy.
Total number of partitions of the service from the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health.
Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.
Polymorphic Discriminator
The status of all the active and idle secondary replicators that the primary is aware of.
Details about the replication queue on the primary replicator.
Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.
A list of the property batch operations to be executed.
Information about the results of a property batch.
Polymorphic Discriminator
Represents the base type for property operations that can be put into a batch and submitted.
Polymorphic Discriminator
The name of the Service Fabric property.
Description of a Service Fabric property.
The property's custom type ID. Using this property, the user is able to tag the type of the value of the property.
The name of the Service Fabric property.
Describes a Service Fabric property value.
Information about a Service Fabric property.
The metadata associated with a property, including the property's name.
The name of the Service Fabric property.
Describes a Service Fabric property value.
The metadata associated with a property, including the property's name.
The property's custom type ID.
Represents when the Property was last modified. Only write operations will cause this field to be updated.
The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists.
The version of the property. Every time a property is modified, its sequence number is increased.
The length of the serialized property value.
The kind of property, determined by the type of data. Following are the possible values. Possible values include: 'Invalid', 'Binary', 'Int64', 'Double', 'String', 'Guid'
Describes a Service Fabric property value.
Polymorphic Discriminator
Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.
The kind of action that needs to be taken for cleaning up the application package after successful provision. Possible values include: 'Invalid', 'Default', 'Automatic', 'Manual'
The relative path for the application package in the image store specified during the prior upload operation.
Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.
Polymorphic Discriminator
Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.
Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true.
Polymorphic Discriminator
Describes the parameters for provisioning a cluster.
The cluster manifest file path.
The cluster code package file path.
Puts the specified property under the specified name. Note that if one PropertyBatchOperation in a PropertyBatch fails, the entire batch fails and cannot be committed in a transactional manner.
The property's custom type ID. Using this property, the user is able to tag the type of the value of the property.
Polymorphic Discriminator
The name of the Service Fabric property.
Describes a Service Fabric property value.
Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.
Replica role before reconfiguration started. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'
Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be "None". Possible values include: 'Unknown', 'None', 'Phase0', 'Phase1', 'Phase2', 'Phase3', 'Phase4', 'AbortPhaseZero'
Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time.
Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be "None". Possible values include: 'Unknown', 'SwapPrimary', 'Failover', 'Other'
Credential information to connect to container registry.
Indicates that supplied container registry password is encrypted.
The password for supplied username to connect to container registry.
The user name to connect to container registry.
Specifying this parameter adds support for reliable collections
False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.
Name of ReliableCollection resource. Right now it's not used and you can use any string.
Provides various statistics of the acknowledgements that are being received from the remote replicator.
Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk.
Represents the average duration it takes for the remote replicator to receive an operation.
Represents the number of operations not yet received by a remote replicator.
Represents the number of operations received and not yet applied by a remote replicator.
Provides details about the remote replicators from the primary replicator's point of view.
Details about the acknowledgements for operations that are part of the copy stream data.
Details about the acknowledgements for operations that are part of the replication stream data.
Represents the state of the secondary replicator from the primary replicator’s point of view.
A value that indicates whether the secondary replica is in the process of being built.
The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary. UTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed.
The highest copy operation sequence number that the secondary has applied to its state. A value of -1 implies that the secondary has applied all copy operations and the copy process is complete.
The highest replication operation sequence number that the secondary has applied to its state.
The highest copy operation sequence number that the secondary has received from the primary. A value of -1 implies that the secondary has received all copy operations.
The highest replication operation sequence number that the secondary has received from the primary.
Represents the acknowledgment status for the remote secondary replicator.
Represents the replica ID of the remote secondary replicator.
Describes the expected impact of executing a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
Polymorphic Discriminator
Describes the entities targeted by a repair action.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
Polymorphic Discriminator
Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
The requested repair action. Must be specified when the repair task is created, and is immutable once set.
A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set.
The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set.
A data string that the repair executor can use to store its internal state.
A bitwise-OR of the following values, which gives additional details about the status of the repair task.
An object that contains timestamps of the repair task's state transitions. These timestamps are updated by the system, and cannot be directly modified.
The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. Impact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set.
A value to determine if health checks will be performed when the repair task enters the Preparing state.
A value to determine if health checks will be performed when the repair task enters the Restoring state.
The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'
The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'
A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.
A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.
A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending'
The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed'
The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. May be set when the repair task is created, and is immutable once set.
The ID of the repair task.
The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value.
Describes a request for forced approval of a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
The ID of the repair task.
The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
Describes a request to cancel a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
True if the repair should be stopped as soon as possible even if it has already started executing. False if the repair should be cancelled only if execution has not yet started.
The ID of the repair task.
The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
Describes a request to delete a completed repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
The ID of the completed repair task to be deleted.
The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed.
A record of the times when the repair task entered each state.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
The time when the repair task entered the Approved state
The time when the repair task entered the Claimed state.
The time when the repair task entered the Completed state
The time when the repair task entered the Created state.
The time when the repair task entered the Executing state
The time when the repair task completed the health check in the Preparing state.
The time when the repair task started the health check in the Preparing state.
The time when the repair task entered the Preparing state.
The time when the repair task completed the health check in the Restoring state.
The time when the repair task started the health check in the Restoring state.
The time when the repair task entered the Restoring state
Describes a request to update the health policy of a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.
A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value.
The ID of the repair task to be updated.
The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed.
Describes the result of an operation that created or updated a repair task.
This type supports the Service Fabric platform; it is not meant to be used directly from your code.
The new version of the repair task.
Represents the base for all Replica Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
The time event was logged.
Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and the unhealthy evaluations.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Id of the partition to which this replica belongs.
Polymorphic Discriminator
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Id of the partition to which the replica belongs.
Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.
List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation.
Represents a base class for stateful service replica or stateless service instance health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The ID of the partition to which this replica belongs.
Polymorphic Discriminator
Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.
The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
The list of replica health state chunks that respect the input filters in the chunk query.
Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk. One filter can match zero, one or multiple replicas, depending on its properties.
The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states. The possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state. If not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).
Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists. If the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter. If the replica exists, it is included in the cluster health chunk if it respects the other filter properties. If not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
Information about the identity, status, health, node name, uptime, and other details about the replica.
The address the replica is listening on.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The last in build duration of the replica in seconds.
The name of a Service Fabric node.
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Polymorphic Discriminator
Information about the replica.
Polymorphic Discriminator
Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy.
Total number of replicas in the partition from the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health.
Provides various statistics of the queue used in the service fabric replicator. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc. Depending on the role of the replicator, the properties in this type imply different meanings.
On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary.
On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state.
On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement. On a secondary replicator, this is the smallest sequence number of the operation that is present in the queue.
Represents the latest sequence number of the operation that is available in the queue.
Represents the virtual memory consumed by the queue in bytes.
Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full.
Represents a base class for primary or secondary replicator status. Contains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.
Polymorphic Discriminator
Endpoint of a resolved service partition.
The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener.
The role of the replica where the endpoint is reported. Possible values include: 'Invalid', 'Stateless', 'StatefulPrimary', 'StatefulSecondary'
Information about a service partition and its associated endpoints.
List of resolved service endpoints of a service partition.
The full name of the service with 'fabric:' URI scheme.
A representation of the resolved partition.
The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter.
This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.
CPU limits in cores. At present, only full cores are supported.
The memory limit in GB.
This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.
Requested number of CPU cores. At present, only full cores are supported.
The memory request in GB for this container.
This type describes the resource requirements for a container or a service.
Describes the maximum limits on the resources for a given container.
Describes the requested resources for a given container.
Defines description for restarting a deployed code package on Service Fabric node.
The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package.
The name of the code package defined in the service manifest.
The name of service manifest that specified this code package.
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string.
Describes the parameters to restart a Service Fabric node.
Specify True to create a dump of the fabric node process. This is case-sensitive. Possible values include: 'False', 'True'. Default value: 'False'.
The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of "0" would match any instance ID. The instance ID can be obtained using get node query. Default value: '0'.
Represents information about an operation in a terminal state (Completed or Faulted).
If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason.
This class returns information about the partition that the user-induced operation acted upon.
Specifies the parameters needed to trigger a restore of a specific partition.
Unique backup ID.
Location of the backup relative to the backup storage specified/ configured.
Location of the backup from where the partition will be restored.
Describes the progress of a restore operation on a partition.
Denotes the failure encountered in performing restore operation.
Represents the current state of the partition restore operation. Possible values include: 'Invalid', 'Accepted', 'RestoreInProgress', 'Success', 'Failure', 'Timeout'
Describes the epoch at which the partition is restored.
Restored LSN.
Timestamp when operation succeeded or failed.
Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade
The name of the upgrade domain in which to resume the upgrade.
Describes the parameters for resuming a cluster upgrade.
The next upgrade domain for this cluster upgrade.
Describes the retention policy configured.
Polymorphic Discriminator
Describes the parameters for updating a rolling upgrade of application or cluster.
The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: 'Invalid', 'Rollback', 'Manual'
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
Polymorphic Discriminator
A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
Describes the mechanism for performing a scaling operation.
Polymorphic Discriminator
Describes how the scaling should be performed
Specifies the mechanism associated with this scaling policy
Specifies the trigger associated with this scaling policy
Describes the trigger for performing a scaling operation.
Polymorphic Discriminator
Status of the secondary replicator when it is in active mode and is part of the replica set.
Details about the copy queue on the secondary replicator.
Value that indicates whether the replica is currently being built.
Polymorphic Discriminator
The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
Details about the replication queue on the secondary replicator.
Status of the secondary replicator when it is in idle mode and is being built by the primary.
Details about the copy queue on the secondary replicator.
Value that indicates whether the replica is currently being built.
Polymorphic Discriminator
The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
Details about the replication queue on the secondary replicator.
Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.
Details about the copy queue on the secondary replicator.
Value that indicates whether the replica is currently being built.
Polymorphic Discriminator
The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator. UTC 0 represents an invalid value, indicating that an acknowledgment message was never sent.
The last time-stamp (UTC) at which a copy operation was received from the primary. UTC 0 represents an invalid value, indicating that a copy operation message was never received.
The last time-stamp (UTC) at which a replication operation was received from the primary. UTC 0 represents an invalid value, indicating that a replication operation message was never received.
Details about the replication queue on the secondary replicator.
This type describes a secret resource.
Name of the Secret resource.
Describes the properties of a secret resource.
Describes the properties of a secret resource.
The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed.
User readable description of the secret.
Polymorphic Discriminator
Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the secret. NOTE: This property will not be serialized. It can only be populated by the server.
This type describes the properties of a secret resource, including its kind.
Polymorphic Discriminator
This type represents the unencrypted value of the secret.
The actual value of the secret.
This type describes properties of secret value resource.
The actual value of the secret.
This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.
Version identifier of the secret value.
The actual value of the secret.
Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.
Polymorphic Discriminator
This class returns information about the partition that the user-induced operation acted upon.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The name of the service the partition belongs to.
Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.
Polymorphic Discriminator
Specifies the scope at which the backup policy is applied. Possible values include: 'Invalid', 'Partition', 'Service', 'Application'
The name of the backup policy which is applicable to this Service Fabric application or service or partition.
The full name of the service with 'fabric:' URI scheme.
Describes the backup suspension details.
Identifies the Service Fabric stateful service which is being backed up.
Polymorphic Discriminator
The full name of the service with 'fabric:' URI scheme.
Creates a particular correlation between services.
The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. Possible values include: 'Invalid', 'Affinity', 'AlignedAffinity', 'NonAlignedAffinity'
The name of the service that the correlation relationship is established with.
Service Created event.
Application name.
Application type name.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Indicates if Service is stateful.
Polymorphic Discriminator
Minimum size of replicas set.
Number of partitions.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Id of Service instance.
Version of Service package.
Service type name.
Size of target replicas set.
The time event was logged.
Service Deleted event.
Application name.
Application type name.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Indicates if Service is stateful.
Polymorphic Discriminator
Minimum size of replicas set.
Number of partitions.
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Id of Service instance.
Version of Service package.
Service type name.
Size of target replicas set.
The time event was logged.
A ServiceDescription contains all of the information necessary to create a service.
The name of the application, including the 'fabric:' URI scheme.
The correlation scheme.
The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'
The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
Indicates if the DefaultMoveCost property is specified.
The partition description as an object.
The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
Scaling policies for this service.
The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
Polymorphic Discriminator
The service load metrics.
The full name of the service with 'fabric:' URI scheme.
The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'
The service placement policies.
Name of the service type as specified in the service manifest.
Represents the base for all Service Events.
The category of event.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Polymorphic Discriminator
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
The time event was logged.
Defines description for creating a Service Fabric service from a template defined in the application manifest.
The name of the application, including the 'fabric:' URI scheme.
The initialization data for the newly created service instance.
The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
The full name of the service with 'fabric:' URI scheme.
The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'
Name of the service type as specified in the service manifest.
Information about the health of a Service Fabric service.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
The name of the service whose health information is described by this object.
The list of partition health states associated with the service.
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Name of the service whose health evaluation is described by this object.
List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation.
Service Health Report Expired event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Id of Service instance.
Polymorphic Discriminator
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Represents the health state of a service, which contains the service identifier and its aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Name of the service whose health state is represented by this object.
Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description.
The name of the service whose health state chunk is provided in this object.
The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
The list of service health state chunks that respect the input filters in the chunk query.
Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only returned if the parent application matches a filter specified in the cluster health chunk query description. One filter can match zero, one or multiple services, depending on its properties.
The filter for the health state of the services. It allows selecting services if they match the desired health states. The possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state. If not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).
Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter. If the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters. The service filter may specify multiple partition filters. For example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID.
The name of the service that matches the filter. The filter is applied only to the specified service, if it exists. If the service doesn't exist, no service is returned in the cluster health chunk based on this filter. If the service exists, it is included as the application's child if the health state matches the other filter properties. If not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.
Map service identity friendly name to an application identity.
The application identity name.
The identity friendly name.
Information about a Service Fabric service.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Whether the service is in a service group.
The version of the service manifest.
The full name of the service with 'fabric:' URI scheme.
Polymorphic Discriminator
The status of the application. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'
Name of the service type as specified in the service manifest.
Specifies a metric to load balance a service during runtime.
Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric.
The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive.
Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica.
Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica.
The service load metric relative weight, compared to other metrics configured for this service, as a number. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Information about the service name.
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
The full name of the service with 'fabric:' URI scheme.
Service Health Report Created event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Id of Service instance.
Polymorphic Discriminator
Describes the property.
Indicates the removal when it expires.
Sequence number of report.
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Information about a partition of a Service Fabric service.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Information about the partition identity, partitioning scheme and keys supported by it.
The status of the service fabric service partition. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'
Polymorphic Discriminator
Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.
The name of the domain that should not be used for placement.
Polymorphic Discriminator
Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.
Polymorphic Discriminator
Describes the policy to be used for placement of a Service Fabric service.
Polymorphic Discriminator
Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.
This placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.
The name of the domain that should used for placement as per this policy.
Polymorphic Discriminator
Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.
While this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.
The name of the domain that should used for placement as per this policy.
Polymorphic Discriminator
Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain
The name of the domain that should used for placement as per this policy.
Polymorphic Discriminator
Describes properties of a service resource.
Auto scaling policies
User readable description of the service.
Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.
The service identity list.
The number of replicas of the service to create. Defaults to 1 if not specified.
Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the service. NOTE: This property will not be serialized. It can only be populated by the server.
When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. NOTE: This property will not be serialized. It can only be populated by the server.
Describes a replica of a service resource.
Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
Reference to sinks in DiagnosticsDescription.
The names of the private networks that this service needs to be part of.
The operation system required by the code in service. Possible values include: 'Linux', 'Windows'
Name of the replica.
Describes the properties of a service replica.
Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
Reference to sinks in DiagnosticsDescription.
The names of the private networks that this service needs to be part of.
The operation system required by the code in service. Possible values include: 'Linux', 'Windows'
This type describes a service resource.
Auto scaling policies
Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).
User readable description of the service.
Reference to sinks in DiagnosticsDescription.
Describes the health state of an application resource. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.
The service identity list.
Name of the Service resource.
The names of the private networks that this service needs to be part of.
The operation system required by the code in service. Possible values include: 'Linux', 'Windows'
The number of replicas of the service to create. Defaults to 1 if not specified.
Status of the service. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the service. NOTE: This property will not be serialized. It can only be populated by the server.
When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. NOTE: This property will not be serialized. It can only be populated by the server.
Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.
List of service type extensions.
Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
Polymorphic Discriminator
The service load metrics is given as an array of ServiceLoadMetricDescription objects.
The placement constraint to be used when instantiating this service in a Service Fabric cluster.
List of service placement policy descriptions.
Name of the service type as specified in the service manifest.
Describes extension of a service type defined in the service manifest.
The name of the extension.
The extension value.
Represents the health policy used to evaluate the health of services belonging to a service type.
The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100
The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. Default value: 0.
The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.
The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. Default value: 0.
The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.
The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. Default value: 0.
Defines an item in ServiceTypeHealthPolicyMap.
The key of the service type health policy map item. This is the name of the service type.
The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.
Information about a service type that is defined in a service manifest of a provisioned application type.
Indicates whether the service is a service group. If it is, the property value is true otherwise false.
The name of the service manifest in which this service type is defined.
The version of the service manifest in which this service type is defined.
Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.
Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.
The XML manifest as a string.
A ServiceUpdateDescription contains all of the information necessary to update a service.
The correlation scheme.
The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.
The service load metrics.
The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
Scaling policies for this service.
Polymorphic Discriminator
The service placement policies.
Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy.
Name of the service type of the services.
Total number of services of the current service type in the application from the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health.
Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\secrets". The path for Linux container is "/var/secrets".
The name of the setting.
The value of the setting.
Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Polymorphic Discriminator
Describes the partition scheme of a singleton-partitioned, or non-partitioned service.
Polymorphic Discriminator
Describes the parameters for starting a cluster upgrade.
Defines the application health policy map used to evaluate the health of an application or one of its children entities.
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
The cluster code version.
The cluster configuration version.
When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
Describes the parameters for monitoring an upgrade in Monitored mode.
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto'.
Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default'.
The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling'.
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
Describes a Chaos event that gets generated when Chaos is started.
Defines all the parameters to configure a Chaos run.
Polymorphic Discriminator
The UTC timestamp when this Chaos event was generated.
Stateful Replica Health Report Expired event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Describes the property.
Indicates the removal when it expires.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Id of Replica instance.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Stateful Replica Health Report Created event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Describes the property.
Indicates the removal when it expires.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Id of Replica instance.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Describes a stateful service.
The name of the application, including the 'fabric:' URI scheme.
The correlation scheme.
The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.
A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
Indicates if the DefaultMoveCost property is specified.
The minimum replica set size as a number.
The partition description as an object.
The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.
The duration, in seconds, between when a replica goes down and when a new replica is created.
Scaling policies for this service.
The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
Polymorphic Discriminator
The service load metrics.
The full name of the service with 'fabric:' URI scheme.
The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'
The service placement policies.
Name of the service type as specified in the service manifest.
The definition on how long StandBy replicas should be maintained before being removed.
The target replica set size as a number.
Information about a stateful Service Fabric service.
Whether the service has persisted state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Whether the service is in a service group.
The version of the service manifest.
The full name of the service with 'fabric:' URI scheme.
Polymorphic Discriminator
The status of the application. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'
Name of the service type as specified in the service manifest.
Information about a partition of a stateful Service Fabric service..
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration.
The minimum replica set size as a number.
Information about the partition identity, partitioning scheme and keys supported by it.
The status of the service fabric service partition. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'
An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.
Polymorphic Discriminator
The target replica set size as a number.
Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Id of the partition to which this replica belongs.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Polymorphic Discriminator
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The ID of the partition to which this replica belongs.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Polymorphic Discriminator
Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.
The address the replica is listening on.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The last in build duration of the replica in seconds.
The name of a Service Fabric node.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
The role of a replica of a stateful service. Possible values include: 'Unknown', 'None', 'Primary', 'IdleSecondary', 'ActiveSecondary'
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Polymorphic Discriminator
Describes a stateful service type defined in the service manifest of a provisioned application type.
List of service type extensions.
A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false.
Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
Polymorphic Discriminator
The service load metrics is given as an array of ServiceLoadMetricDescription objects.
The placement constraint to be used when instantiating this service in a Service Fabric cluster.
List of service placement policy descriptions.
Name of the service type as specified in the service manifest.
Describes an update for a stateful service.
The correlation scheme.
The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.
The service load metrics.
The minimum replica set size as a number.
The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss.
The duration, in seconds, between when a replica goes down and when a new replica is created.
Scaling policies for this service.
Polymorphic Discriminator
The service placement policies.
The definition on how long StandBy replicas should be maintained before being removed.
The target replica set size as a number.
Stateless Replica Health Report Expired event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Describes the property.
Indicates the removal when it expires.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Stateless Replica Health Report Created event.
The category of event.
Description of report.
The identifier for the FabricEvent instance.
Shows there is existing related events available.
Describes the property health state.
Polymorphic Discriminator
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
Describes the property.
Indicates the removal when it expires.
Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.
Sequence number of report.
Id of report source.
Source time.
The time event was logged.
Time to live in milli-seconds.
Describes a stateless service.
The name of the application, including the 'fabric:' URI scheme.
The correlation scheme.
The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'
The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created.
The instance count.
Indicates if the DefaultMoveCost property is specified.
The partition description as an object.
The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
Scaling policies for this service.
The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster.
Polymorphic Discriminator
The service load metrics.
The full name of the service with 'fabric:' URI scheme.
The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess'
The service placement policies.
Name of the service type as specified in the service manifest.
Information about a stateless Service Fabric service.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource. Starting in version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions.
Whether the service is in a service group.
The version of the service manifest.
The full name of the service with 'fabric:' URI scheme.
Polymorphic Discriminator
The status of the application. Possible values include: 'Unknown', 'Active', 'Upgrading', 'Deleting', 'Creating', 'Failed'
Name of the service type as specified in the service manifest.
Represents the health of the stateless service instance. Contains the instance aggregated health state, the health events and the unhealthy evaluations.
The HealthState representing the aggregated health state of the entity computed by Health Manager. The health evaluation of the entity reflects all events reported on the entity and its children (if any). The aggregation is done by applying the desired health policy. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The list of health events reported on the entity.
Shows the health statistics for all children types of the queried entity.
Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
Id of the partition to which this replica belongs.
Polymorphic Discriminator
The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
The ID of the partition to which this replica belongs.
Id of the stateless service instance on the wire this field is called ReplicaId.
Polymorphic Discriminator
Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.
The address the replica is listening on.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId.
The last in build duration of the replica in seconds.
The name of a Service Fabric node.
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped'
Polymorphic Discriminator
Information about a partition of a stateless Service Fabric service.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Number of instances of this partition.
Information about the partition identity, partitioning scheme and keys supported by it.
The status of the service fabric service partition. Possible values include: 'Invalid', 'Ready', 'NotReady', 'InQuorumLoss', 'Reconfiguring', 'Deleting'
Polymorphic Discriminator
Describes a stateless service type defined in the service manifest of a provisioned application type.
List of service type extensions.
Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise.
Polymorphic Discriminator
The service load metrics is given as an array of ServiceLoadMetricDescription objects.
The placement constraint to be used when instantiating this service in a Service Fabric cluster.
List of service placement policy descriptions.
Name of the service type as specified in the service manifest.
A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise.
Describes an update for a stateless service.
The correlation scheme.
The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High'
Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.
The instance count.
The service load metrics.
The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)".
Scaling policies for this service.
Polymorphic Discriminator
The service placement policies.
Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.
Polymorphic Discriminator
Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over.
The UTC timestamp when this Chaos event was generated.
Describes a Service Fabric property value of type String.
The data of the property value.
Polymorphic Discriminator
Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any "Get" operations in the batch.
Polymorphic Discriminator
A map containing the properties that were requested through any "Get" property batch operations. The key represents the index of the "Get" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map.
Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation.
Describes the tcp configuration for external connectivity for this network.
Describes destination endpoint for routing traffic.
tcp gateway config name.
Specifies the port at which the service endpoint below needs to be exposed.
Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine. For example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.
Polymorphic Discriminator
Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant.
The UTC timestamp when this Chaos event was generated.
Describes the time based backup schedule.
List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly.
Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored.
Describes the frequency with which to run the time based backup schedule. Possible values include: 'Invalid', 'Daily', 'Weekly'
Polymorphic Discriminator
Defines an hour and minute of the day specified in 24 hour time.
Represents the hour of the day. Value must be between 0 and 23 inclusive.
Represents the minute of the hour. Value must be between 0 to 59 inclusive.
Defines a time range in a 24 hour day specified by a start and end time.
Defines an hour and minute of the day specified in 24 hour time.
Defines an hour and minute of the day specified in 24 hour time.
Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.
The number of partitions.
String indicating the upper bound of the partition key range that should be split between the partitions.
String indicating the lower bound of the partition key range that should be split between the partitions.
Polymorphic Discriminator
Contains information for an unplaced replica.
The ID of the partition.
The name of the service.
List of reasons due to which a replica cannot be placed.
Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.
The version of the application type as defined in the application manifest.
The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned.
Describes the parameters for unprovisioning a cluster.
The cluster code package version.
The cluster manifest version.
Parameters for updating a cluster upgrade.
Defines the application health policy map used to evaluate the health of an application or one of its children entities.
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
Describes the parameters for updating a rolling upgrade of application or cluster.
The type of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling', 'Rolling_ForceRestart'. Default value: 'Rolling'.
Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned during cluster upgrade when cluster aggregated health state is Warning or Error.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade.
Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade.
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy.
Total number of upgrade domain nodes in the health store.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
Name of the upgrade domain where nodes health is currently evaluated.
Information about an upgrade domain.
The name of the upgrade domain
The state of the upgrade domain. Possible values include: 'Invalid', 'Pending', 'InProgress', 'Completed'
Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'
Description of the health evaluation, which represents a summary of the evaluation process.
Polymorphic Discriminator
Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy.
Total number of nodes in the current upgrade domain.
List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health.
Name of the upgrade domain where nodes health is currently evaluated.
Service state of Service Fabric Upgrade Orchestration Service.
The state of Service Fabric Upgrade Orchestration Service.
Service state summary of Service Fabric Upgrade Orchestration Service.
The current code version of the cluster.
The current manifest version of the cluster.
The type of the pending upgrade of the cluster.
The target code version of the cluster.
The target manifest version of the cluster.
Information about which portion of the file to upload.
The end position of the portion of the file. It's represented by the number of bytes.
The start position of the portion of the file. It's represented by the number of bytes.
Information about a image store upload session
When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions.
Information about an image store upload session. A session is associated with a relative path in the image store.
List of chunk ranges that image store has not received yet.
The size in bytes of the uploading file.
The date and time when the upload session was last modified.
A unique ID of the upload session. A session ID can be reused only if the session was committed or removed.
The remote location within image store. This path is relative to the image store root.
Chaos event corresponding to a failure during validation.
Polymorphic Discriminator
Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string.
The UTC timestamp when this Chaos event was generated.
This type describes a volume provided by an Azure Files file share.
Access key of the Azure storage account for the File Share.
Name of the Azure storage account for the File Share.
Name of the Azure Files file share that provides storage for the volume.
Describes a reference to a volume resource.
The path within the container at which the volume should be mounted. Only valid path characters are allowed.
Name of the volume being referenced.
The flag indicating whether the volume is read only. Default is 'false'.
This type describes a volume resource.
This type describes a volume provided by an Azure Files file share.
User readable description of the volume.
Name of the Volume resource.
Status of the volume. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.
Gives additional information about the current status of the volume. NOTE: This property will not be serialized. It can only be populated by the server.
Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.
Polymorphic Discriminator
Id of the partition which is undergoing the safety check.
Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.
Polymorphic Discriminator
Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade.
The UTC timestamp when this Chaos event was generated.
Generated using TypeDoc
Defines values for ApplicationDefinitionKind. Possible values include: 'Invalid', 'ServiceFabricApplicationDescription', 'Compose'
{string}